StripeAPI.Types.Subscription

application: ID of the Connect Application that created the subscription.

application_fee_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.

automatic_tax:

billing_cycle_anchor: Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.

billing_thresholds: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

cancel_at: A date in the future at which the subscription will automatically get canceled

cancel_at_period_end: If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

canceled_at: 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.

collection_method: 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.

created: Time at which the object was created. Measured in seconds since the Unix epoch.

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

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

customer: ID of the customer who owns the subscription.

days_until_due: 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: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

default_source: 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 or default_source.

default_tax_rates: 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: 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.

Constraints:

• Maximum length of 500

discount: Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.

ended_at: If the subscription has ended, the date the subscription ended.

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

items: List of subscription items, each with an attached price.

latest_invoice: The most recent invoice this subscription has generated.

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

next_pending_invoice_item_invoice: Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.

pause_collection: If specified, payment collection for this subscription will be paused.

payment_settings: Payment settings passed on to invoices created by the subscription.

pending_invoice_item_interval: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

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

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

schedule: The schedule attached to the subscription

start_date: Date when the subscription was first created. The date might differ from the `created` date due to backdating.

status: Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`.

For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, 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.

If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.

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: ID of the test clock this subscription belongs to.

transfer_data: 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: If the subscription has a trial, the end of that trial.

trial_start: If the subscription has a trial, the beginning of that trial.

amount_gte: Monetary threshold that triggers the subscription to create an invoice

reset_billing_cycle_anchor: Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.

checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

Constraints:

• Maximum length of 5000

coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

customer: The ID of the customer associated with this discount.

end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

Constraints:

• Maximum length of 5000

invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

Constraints:

• Maximum length of 5000

invoice_item: 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.

Constraints:

• Maximum length of 5000

object: String representing the object's type. Objects of the same type share the same value.

promotion_code: The promotion code applied to create this discount.

start: Date that the coupon was applied.

subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

behavior: The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.

resumes_at: The time after which the subscription will resume collecting payments.

payment_method_options: Payment-method-specific configuration to provide to invoices created by the subscription.

payment_method_types: The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.

save_default_payment_method: Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.

acss_debit: This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.

bancontact: This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.

card: This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.

customer_balance: This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.

konbini: This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.

us_bank_account: This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.

mandate_options:

verification_method: Bank account verification method.

preferred_language: Preferred language of the Bancontact authorization page that the customer is redirected to.

mandate_options:

request_three_d_secure: We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

bank_transfer:

funding_type: The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.

financial_connections:

verification_method: Bank account verification method.

interval: Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.

interval_count: The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

billing_cycle_anchor: If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.

expires_at: The point after which the changes reflected by this update will be discarded and no longer applied.

subscription_items: List of subscription items, each with an attached plan, that will be set if the update is applied.

trial_end: Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.

trial_from_plan: 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 to learn more.

amount_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

destination: The account where funds from the payment will be transferred to upon payment success.