Create a subscription item
Adds a new item to an existing subscription. No existing items will be changed or replaced.
Parameters
- subscriptionstringRequired
The identifier of the subscription to modify.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - payment_
behaviorenum Use
allow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.Use
default_incomplete
to transition the subscription tostatus=past_due
when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.Use
pending_if_incomplete
to update the subscription using pending updates. When you usepending_if_incomplete
you can only pass the parameters supported by pending updates.Use
error_if_incomplete
if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.Possible enum valuesallow_incomplete
default_incomplete
error_if_incomplete
pending_if_incomplete
- pricestring
The ID of the price object.
- proration_
behaviorenum Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now
, or starting a trial), or if an item’squantity
changes. The default value iscreate_prorations
.Possible enum valuesalways_invoice
Always invoice immediately for prorations.
create_prorations
Will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions.
none
Disable creating prorations in this request.
- quantityinteger
The quantity you’d like to apply to the subscription item you’re creating.
More parameters
- billing_
thresholdsobject - discountsarray of objects
- price_
dataobject - proration_
datetimestamp - tax_
ratesarray of strings
Returns
Returns the created Subscription Item
object, if successful. Otherwise, this call raises an error.
{
"id": "si_NcLYdDxLHxlFo7",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1680126546,
"metadata": {},
"price": {
"id": "price_1Mr6rdLkdIwHu7ixwPmiybbR",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1680126545,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_NcLYGKH0eY5b8s",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"trial_period_days": null,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 2,
"subscription": "sub_1Mr6rbLkdIwHu7ix4Xm9Ahtd",
"tax_rates": []
}
Update a subscription item
Updates the plan or quantity of an item on a current subscription.
Parameters
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - payment_
behaviorenum Use
allow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.Use
default_incomplete
to transition the subscription tostatus=past_due
when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.Use
pending_if_incomplete
to update the subscription using pending updates. When you usepending_if_incomplete
you can only pass the parameters supported by pending updates.Use
error_if_incomplete
if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.Possible enum valuesallow_incomplete
default_incomplete
error_if_incomplete
pending_if_incomplete
- pricestring
The ID of the price object. When changing a subscription item’s price,
quantity
is set to 1 unless aquantity
parameter is provided. - proration_
behaviorenum Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now
, or starting a trial), or if an item’squantity
changes. The default value iscreate_prorations
.Possible enum valuesalways_invoice
Always invoice immediately for prorations.
create_prorations
Will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions.
none
Disable creating prorations in this request.
- quantityinteger
The quantity you’d like to apply to the subscription item you’re creating.
More parameters
- billing_
thresholdsobject - discountsarray of objects
- off_
sessionboolean - price_
dataobject - proration_
datetimestamp - tax_
ratesarray of strings
Returns
{
"id": "si_NcLYdDxLHxlFo7",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1680126546,
"metadata": {
"order_id": "6735"
},
"price": {
"id": "price_1Mr6rdLkdIwHu7ixwPmiybbR",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1680126545,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_NcLYGKH0eY5b8s",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"trial_period_days": null,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 2,
"subscription": "sub_1Mr6rbLkdIwHu7ix4Xm9Ahtd",
"tax_rates": []
}
Retrieve a subscription item
Retrieves the subscription item with the given ID.
Parameters
No parameters.
Returns
Returns a subscription item if a valid subscription item ID was provided. Raises an error otherwise.
{
"id": "si_NcLYdDxLHxlFo7",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1680126546,
"metadata": {},
"price": {
"id": "price_1Mr6rdLkdIwHu7ixwPmiybbR",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1680126545,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_NcLYGKH0eY5b8s",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"trial_period_days": null,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 2,
"subscription": "sub_1Mr6rbLkdIwHu7ix4Xm9Ahtd",
"tax_rates": []
}
List all subscription items
Returns a list of your subscription items for a given subscription.
Parameters
- subscriptionstringRequired
The ID of the subscription whose items will be retrieved.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
subscription items, starting after subscription item starting_after
. Each entry in the array is a separate subscription item object. If no more subscription items are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/subscription_items",
"has_more": false,
"data": [
{
"id": "si_OCgWsGlqpbN4EP",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1688507587,
"metadata": {},
"price": {
"id": "price_1NQH9iLkdIwHu7ix3tkaSxhj",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1688507586,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_OCgWE6cbwiSu27",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"trial_period_days": null,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1NQH9iLkdIwHu7ixxhHui9yi",
"tax_rates": []
}
{...}
{...}
],
}
Delete a subscription item
Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
Parameters
- proration_
behaviorenum Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now
, or starting a trial), or if an item’squantity
changes. The default value iscreate_prorations
.Possible enum valuesalways_invoice
Always invoice immediately for prorations.
create_prorations
Will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions.
none
Disable creating prorations in this request.
More parameters
- clear_
usageboolean - proration_
datetimestamp
Returns
An subscription item object with a deleted flag upon success. Otherwise, this call raises an error, such as if the subscription item has already been deleted.
{
"id": "si_NcLYdDxLHxlFo7",
"object": "subscription_item",
"deleted": true
}