Lemon Squeezy icon

Lemon Squeezy

Interact with Lemon Squeezy API

Usage Record → Create

AI-generated

Summary

Create a usage record for a specific subscription item in Lemon Squeezy, either incrementing the existing usage quantity or setting it to a precise value.

Inputs

  • Subscription Item ID (required) — The ID of the subscription item to record usage for.
  • Quantity (required) — The usage quantity to record; must be a positive integer (minimum 1).
  • Action (required) — Specifies whether to increment the existing recorded usage by the given quantity or to set the usage exactly to the given quantity. Options are 'increment' or 'set'.
  • Simplify — Whether to simplify the response by flattening JSON:API attributes to the top level (default true). Disable to get the raw JSON:API format including type, attributes, and relationships.
  • Retry Options — Optional configuration for automatic retry behavior on failed API requests, including max retries and initial delay in milliseconds.

Output shape

a single usage record object as returned by the Lemon Squeezy API

The returned usage record reflects the updated usage state for the specified subscription item. Output simplification applies if enabled, otherwise the full JSON:API response structure is returned.

Examples

Example 1: Record additional usage by incrementing quantity

Set Subscription Item ID to the target item's ID, Quantity to the increment amount, and Action to 'increment'. The node will add this quantity to the current usage.

Example 2: Set usage to a specific total quantity

Set Subscription Item ID to the target, Quantity to the desired total usage, and Action to 'set'. This overwrites the usage to the exact quantity specified.

Links

Discussion