API reference

Test mode. Use your secret key on your server; live processing is currently disabled.

https://api.knoxapi.com

Send form-encoded requests with Authorization: Bearer sk_test_....

Complete OpenAPI specification · Integration guide

Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.

GET /v1/subscriptions

List subscriptions

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

Request parameters

Parameter	Location	Type	Description
`automatic_tax`	query	object	Filter subscriptions by their automatic tax settings.
`collection_method`	query	string	The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
`created`	query	one of multiple schemas	Only return subscriptions that were created during the given date interval.
`current_period_end`	query	one of multiple schemas	Only return subscriptions whose minimum item current_period_end falls within the given date interval.
`current_period_start`	query	one of multiple schemas	Only return subscriptions whose maximum item current_period_start falls within the given date interval.
`customer`	query	string	The ID of the customer whose subscriptions you're retrieving.
`customer_account`	query	string	The ID of the account representing the customer whose subscriptions you're retrieving.
`ending_before`	query	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`price`	query	string	Filter for subscriptions that contain this recurring price ID.
`starting_after`	query	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
`status`	query	string	The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
`test_clock`	query	string	Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of subscription
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/subscriptions

Create a subscription

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.

Request parameters

Field	Type	Description
`add_invoice_items`	array of object	A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
`application_fee_percent`	one of multiple schemas	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
`automatic_tax`	object	Automatic tax settings for this subscription.
`backdate_start_date`	integer	A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
`billing_cycle_anchor`	integer	A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
`billing_cycle_anchor_config`	object	Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
`billing_mode`	object	Controls how prorations and invoices for subscriptions are calculated and orchestrated.
`billing_schedules`	array of object	An array of billing schedules, which allow you to bill customers in advance for multiple service periods. Requires flexible billing mode and API version 2026-05-27.dahlia or later. Learn more about [prebilling](https://docs.stripe.com/billing/subscriptions/prebilling).
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
`cancel_at`	one of multiple schemas	A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
`cancel_at_period_end`	boolean	Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
`collection_method`	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
`currency`	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer`	string	The identifier of the customer to subscribe.
`customer_account`	string	The identifier of the account representing the customer to subscribe.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
`default_payment_method`	string	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	string	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	one of multiple schemas	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts`	one of multiple schemas	The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
`expand`	array of string	Specifies which fields in the response should be expanded.
`invoice_settings`	object	All invoices will be billed using the specified settings.
`items`	array of object	A list of up to 20 subscription items, each with an attached price.
`metadata`	one of multiple schemas	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
`off_session`	boolean	Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
`on_behalf_of`	one of multiple schemas	The account on behalf of which to charge, for each of the subscription's invoices.
`payment_behavior`	string	Controls how Stripe handles the first invoice when payment is required and `collection_method=charge_automatically`. Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
`payment_settings`	object	Payment settings to pass to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`proration_behavior`	string	Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
`transfer_data`	object	If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
`trial_end`	one of multiple schemas	Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
`trial_from_plan`	boolean	Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
`trial_period_days`	integer	Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
`trial_settings`	object	Settings related to subscription trials.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/subscriptions/search

Search subscriptions

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`page`	query	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
`query`	query	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions).

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of subscription
`has_more` required	boolean
`next_page`	string
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`total_count`	integer	The total number of objects that match the query, only accurate up to 10,000.
`url` required	string

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

DELETE /v1/subscriptions/{subscription_exposed_id}

Cancel a subscription

Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, the subscription is largely immutable. You can still update its metadata and cancellation_details. Any pending invoice items that you’ve created are still charged at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to false. By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

Request parameters

Parameter	Location	Type	Description
`subscription_exposed_id`	path	string

Field	Type	Description
`cancellation_details`	object	Details about why this subscription was cancelled
`expand`	array of string	Specifies which fields in the response should be expanded.
`invoice_now`	boolean	Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
`prorate`	boolean	Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/subscriptions/{subscription_exposed_id}

Retrieve a subscription

Retrieves the subscription with the given ID.

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`subscription_exposed_id`	path	string

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/subscriptions/{subscription_exposed_id}

Update a subscription

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 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. You can also use scripts to prorate your billing. To learn more, see Prorations. 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 on May 1 and 200 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.

Request parameters

Parameter	Location	Type	Description
`subscription_exposed_id`	path	string

Field	Type	Description
`add_invoice_items`	array of object	A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
`application_fee_percent`	one of multiple schemas	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
`automatic_tax`	object	Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
`billing_cycle_anchor`	string	Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
`billing_schedules`	one of multiple schemas	An array of billing schedules, which allow you to bill customers in advance for multiple service periods. Requires flexible billing mode and API version 2026-05-27.dahlia or later. Learn more about [prebilling](https://docs.stripe.com/billing/subscriptions/prebilling).
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
`cancel_at`	one of multiple schemas	A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
`cancel_at_period_end`	boolean	Indicate whether this subscription should cancel at the end of the current period (`current_period_end`).
`cancellation_details`	object	Details about why this subscription was cancelled
`collection_method`	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
`default_payment_method`	string	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	one of multiple schemas	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
`description`	one of multiple schemas	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.
`discounts`	one of multiple schemas	The coupons to redeem into discounts for the subscription. A populated array overwrites the existing discounts on the subscription. If not specified or empty array, it leaves the subscription's discounts unchanged. If empty string, it clears the subscription's discounts.
`expand`	array of string	Specifies which fields in the response should be expanded.
`invoice_settings`	object	All invoices will be billed using the specified settings.
`items`	array of object	A list of up to 20 subscription items, each with an attached price.
`metadata`	one of multiple schemas	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
`off_session`	boolean	Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
`on_behalf_of`	one of multiple schemas	The account on behalf of which to charge, for each of the subscription's invoices.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_behavior`	string	Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`.
`payment_settings`	object	Payment settings to pass to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`proration_behavior`	string	Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/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`.
`proration_date`	integer	If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
`transfer_data`	one of multiple schemas	If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
`trial_end`	one of multiple schemas	Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
`trial_from_plan`	boolean	Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
`trial_settings`	object	Settings related to subscription trials.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

DELETE /v1/subscriptions/{subscription_exposed_id}/discount

Delete a subscription discount

Removes the currently applied discount on a subscription.

Request parameters

Parameter	Location	Type	Description
`subscription_exposed_id`	path	string

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`checkout_session`	string	The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
`customer`	one of multiple schemas	The ID of the customer associated with this discount.
`customer_account`	string	The ID of the account representing the customer associated with this discount.
`deleted` required	boolean	Always true for a deleted object
`id` required	string	The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
`invoice`	string	The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
`invoice_item`	string	The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`promotion_code`	one of multiple schemas	The promotion code applied to create this discount.
`source` required	discount_source
`start` required	integer	Date that the coupon was applied.
`subscription`	string	The subscription that this coupon is applied to, if it is applied to a particular subscription.
`subscription_item`	string	The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/subscriptions/{subscription}/migrate

Migrate a subscription

Upgrade the billing_mode of an existing subscription.

Request parameters

Parameter	Location	Type	Description
`subscription`	path	string

Field	Type	Description
`billing_mode` required	object	Controls how prorations and invoices for subscriptions are calculated and orchestrated.
`expand`	array of string	Specifies which fields in the response should be expanded.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/subscriptions/{subscription}/resume

Resume a subscription

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn’t generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about resuming subscriptions.

Request parameters

Parameter	Location	Type	Description
`subscription`	path	string

Field	Type	Description
`billing_cycle_anchor`	string	The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
`expand`	array of string	Specifies which fields in the response should be expanded.
`proration_behavior`	string	Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
`proration_date`	integer	If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.

Responses

HTTP 200: Successful response.

Field	Type	Description
`application`	one of multiple schemas	ID of the Connect Application that created the subscription.
`application_fee_percent`	number	A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
`automatic_tax` required	subscription_automatic_tax
`billing_cycle_anchor` required	integer	The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
`billing_cycle_anchor_config`	one of multiple schemas	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_mode` required	subscriptions_resource_billing_mode
`billing_schedules` required	array of subscriptions_resource_billing_schedules	Billing schedules for this subscription.
`billing_thresholds`	one of multiple schemas	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`cancel_at`	integer	A date in the future at which the subscription will automatically get canceled
`cancel_at_period_end` required	boolean	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	integer	If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
`cancellation_details`	one of multiple schemas	Details about why this subscription was cancelled
`collection_method` required	string	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`currency` required	string	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
`customer` required	one of multiple schemas	ID of the customer who owns the subscription.
`customer_account`	string	ID of the account representing the customer who owns the subscription.
`days_until_due`	integer	Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
`default_payment_method`	one of multiple schemas	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](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_source`	one of multiple schemas	ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
`default_tax_rates`	array of tax_rate	The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
`description`	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.
`discounts` required	array of one of multiple schemas	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`ended_at`	integer	If the subscription has ended, the date the subscription ended.
`id` required	string	Unique identifier for the object.
`invoice_settings` required	subscriptions_resource_subscription_invoice_settings
`items` required	object	List of subscription items, each with an attached price.
`latest_invoice`	one of multiple schemas	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	one of multiple schemas	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`metadata` required	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`next_pending_invoice_item_invoice`	integer	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	one of multiple schemas	The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
`pause_collection`	one of multiple schemas	If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
`payment_settings`	one of multiple schemas	Payment settings passed on to invoices created by the subscription.
`pending_invoice_item_interval`	one of multiple schemas	Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval.
`pending_setup_intent`	one of multiple schemas	You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) 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](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
`pending_update`	one of multiple schemas	If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
`presentment_details`	subscriptions_resource_subscription_presentment_details
`schedule`	one of multiple schemas	The schedule attached to the subscription
`start_date` required	integer	Date when the subscription was first created. The date might differ from the `created` date due to backdating.
`status` required	string	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](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). 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](https://docs.stripe.com/billing/subscriptions/pause-payment), 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.
`test_clock`	one of multiple schemas	ID of the test clock this subscription belongs to.
`transfer_data`	one of multiple schemas	The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
`trial_end`	integer	If the subscription has a trial, the end of that trial.
`trial_settings`	one of multiple schemas	Settings related to subscription trials.
`trial_start`	integer	If the subscription has a trial, the beginning of that trial.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors