Subscription Items
Create, retrieve, update, delete, and list the price/quantity pairs within a subscription.
A subscription item represents a single price and quantity pair within a subscription. Multi-item subscriptions use one item per price, letting you mix flat fees, per-seat charges, and metered usage on a single billing cycle.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The subscription item objectAsk
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier, e.g. si_7Bm3qR. |
subscription | string | The sub_ this item belongs to. Expandable. |
price | string | The price_ charged for this line. Expandable. |
quantity | integer | Number of units (omitted for metered prices). |
created | timestamp | Unix timestamp when the item was created. |
Create a subscription itemAsk
Add a new price to an existing subscription. VINR prorates the charge for the remainder of the current period by default.
Retrieve a subscription itemAsk
Update a subscription itemAsk
Change the quantity or swap the price. VINR prorates the difference for the current period unless
you pass proration_behavior: 'none'.
Delete a subscription itemAsk
Removes the item from the subscription. VINR generates a prorated credit for any unused time by
default; pass proration_behavior=none to skip the credit.
List subscription itemsAsk
Returns all items for a given subscription.
Related eventsAsk
customer.subscription.updated is fired whenever items are added, changed, or removed. See
Events.
