Attributes

• idstring

  Unique identifier for the object.

• automatic_taxhash

  Automatic tax settings for this subscription.

  Show child attributes

• cancel_at_period_endboolean

  Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• current_period_endtimestamp

  End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

• current_period_starttimestamp

  Start of the current period that the subscription has been invoiced for.

• customerstringExpandable

  ID of the customer who owns the subscription.

• default_payment_methodnullable stringExpandable

  ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

• descriptionnullable string

  The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

• itemshash

  List of subscription items, each with an attached price.

  Show child attributes

• latest_invoicenullable stringExpandable

  The most recent invoice this subscription has generated.

• metadatahash

  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.

• pending_setup_intentnullable stringExpandable

  You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription’s payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.

• pending_updatenullable hash

  If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.

  Show child attributes

• statusenum

  Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

  For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

  A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

  A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn’t generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription’s status unchanged.

  If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

  If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

More attributes

Expand all

• objectstring

• applicationnullable stringExpandableConnect only

• application_fee_percentnullable floatConnect only

• billing_cycle_anchortimestamp

• billing_cycle_anchor_confignullable hash

• billing_thresholdsnullable hash

• cancel_atnullable timestamp

• canceled_atnullable timestamp

• cancellation_detailsnullable hash

• collection_methodenum

• createdtimestamp

• days_until_duenullable integer

• default_sourcenullable stringExpandable

• default_tax_ratesnullable array of hashes

• discountnullable hashDeprecated

• discountsarray of stringsExpandable

• ended_atnullable timestamp

• invoice_settingshash

• livemodeboolean

• next_pending_invoice_item_invoicenullable timestamp

• on_behalf_ofnullable stringExpandableConnect only

• pause_collectionnullable hash

• payment_settingsnullable hash

• pending_invoice_item_intervalnullable hash

• schedulenullable stringExpandable

• start_datetimestamp

• test_clocknullable stringExpandable

• transfer_datanullable hashConnect only

• trial_endnullable timestamp

• trial_settingsnullable hash

• trial_startnullable timestamp

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. Schedules provide the flexibility to model more complex billing configurations that change over time.

Parameters

• customerstringRequired

  The identifier of the customer to subscribe.

• automatic_taxhash

  Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

  Show child parameters

• cancel_at_period_endboolean

  Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• default_payment_methodstring

  ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

• descriptionstring

  The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

• itemsarray of hashesRequired

  A list of up to 20 subscription items, each with an attached price.

  Show child parameters

• metadatahash

  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

  Only applies to subscriptions with collection_method=charge_automatically.

  Use allow_incomplete to create Subscriptions with status=incomplete if the first invoice can’t be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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 create Subscriptions with status=incomplete when the first invoice requires payment, otherwise start as active. Subscriptions transition to status=active when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to status=incomplete_expired, which is a terminal state.

  Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s first invoice can’t be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn’t create a 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.

  pending_if_incomplete is only used with updates and cannot be passed when creating a Subscription.

  Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.

  Possible enum values

  allow_incomplete

  default_incomplete

  error_if_incomplete

  pending_if_incomplete

More parameters

Expand all

• add_invoice_itemsarray of hashes

• application_fee_percentfloatConnect only

• backdate_start_datetimestamp

• billing_cycle_anchortimestamp

• billing_cycle_anchor_confighash

• billing_thresholdshash

• cancel_attimestamp

• collection_methodenum

• couponstringDeprecated

• days_until_dueinteger

• default_sourcestring

• default_tax_ratesarray of strings

• discountsarray of hashes

• invoice_settingshash

• off_sessionboolean

• on_behalf_ofstring

• payment_settingshash

• pending_invoice_item_intervalhash

• promotion_codestringDeprecated

• proration_behaviorenum

• transfer_datahashConnect only

• trial_endstring | timestamp

• trial_from_planboolean

• trial_period_daysinteger

• trial_settingshash

Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the create preview endpoint.

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 USD price, they’ll be billed 100 USD immediately. If on May 15 they switch to a 200 USD price, then on June 1 they’ll be billed 250 USD (200 USD for a renewal of her subscription, plus a 50 USD prorating adjustment for half of the previous month’s 100 USD difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

Switching prices does not normally change the billing date or generate an immediate charge unless:

• The billing interval is changed (for example, from monthly to yearly).
• The subscription moves from free to paid.
• A trial starts or ends.

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 USD on May 1 and 200 USD on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

Parameters

• automatic_taxhash

  Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

  Show child parameters

• cancel_at_period_endboolean

  Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.

• default_payment_methodstring

  ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

• descriptionstring

  The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

• itemsarray of hashes

  A list of up to 20 subscription items, each with an attached price.

  Show child parameters

• metadatahash

  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

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

More parameters

Expand all

• add_invoice_itemsarray of hashes

• application_fee_percentfloatConnect only

• billing_cycle_anchorstring

• billing_thresholdshash

• cancel_attimestamp

• cancellation_detailshash

• collection_methodenum

• couponstringDeprecated

• days_until_dueinteger

• default_sourcestring

• default_tax_ratesarray of strings

• discountsarray of hashes

• invoice_settingshash

• off_sessionboolean

• on_behalf_ofstring

• pause_collectionhash

• payment_settingshash

• pending_invoice_item_intervalhash

• promotion_codestringDeprecated

• proration_datetimestamp

• transfer_datahashConnect only

• trial_endstring | timestamp

• trial_from_planboolean

• trial_settingshash

Retrieves the subscription with the given ID.

Parameters

No parameters.