Attributes

• idstring

  Unique identifier for the object.

• 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.

• priceobject

  The price the customer is subscribed to.

  Show child attributes

• quantitynullable integer

  The quantity of the plan to which the customer should be subscribed.

• subscriptionstring

  The subscription this subscription_item belongs to.

More attributes

Expand all

• objectstring

• billing_thresholdsnullable object

• createdinteger

• current_period_endtimestamp

• current_period_starttimestamp

• discountsarray of stringsExpandable

• tax_ratesnullable array of objects

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 to status=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 to status=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 use pending_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 values

  allow_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’s quantity changes. The default value is create_prorations.

  Possible enum values

  always_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

Expand all

• billing_thresholdsobject

• discountsarray of objects

• price_dataobject

• proration_datetimestamp

• tax_ratesarray of strings

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 to status=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 to status=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 use pending_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 values

  allow_incomplete

  default_incomplete

  error_if_incomplete

  pending_if_incomplete

• pricestring

  The ID of the price object. One of price or price_data is required. When changing a subscription item’s price, quantity is set to 1 unless a quantity 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’s quantity changes. The default value is create_prorations.

  Possible enum values

  always_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

Expand all

• billing_thresholdsobject

• discountsarray of objects

• off_sessionboolean

• price_dataobject

• proration_datetimestamp

• tax_ratesarray of strings

Retrieves the subscription item with the given ID.

Parameters

No parameters.

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

Expand all

• ending_beforestring

• limitinteger

• starting_afterstring