Stripe: Subscriptions schemas

41 Stripe schemas with complete fields and constraints.

← Subscriptions operations · All schemas

Create a subscription — subscriptions post Subscriptions — request body — body invoice settings

Field	Type	Presence	Description and constraints
`$`	object	Root	All invoices will be billed using the specified settings.
`account_tax_ids`	JSON	Optional
`account_tax_ids (anyOf 1)`	array	Alternative
`account_tax_ids (anyOf 1)[]`	string	Each item	Maximum length: 5000
`account_tax_ids (anyOf 2)`	string	Alternative	One of:
`custom_fields`	JSON	Optional
`custom_fields (anyOf 1)`	array	Alternative
`custom_fields (anyOf 1)[]`	object	Each item
`custom_fields (anyOf 1)[].name`	string	Required within parent	Maximum length: 40
`custom_fields (anyOf 1)[].value`	string	Required within parent	Maximum length: 140
`custom_fields (anyOf 2)`	string	Alternative	One of:
`description`	string	Optional	Maximum length: 1500
`footer`	string	Optional	Maximum length: 5000
`issuer`	object	Optional
`issuer.account`	string	Optional
`issuer.type`	string	Required within parent	One of: account, self

Create a subscription — subscriptions post Subscriptions — request body — body items item

Field	Type	Presence	Description and constraints
`$`	object	Root
`billing_thresholds`	JSON	Optional
`billing_thresholds (anyOf 1)`	object	Alternative
`billing_thresholds (anyOf 1).usage_gte`	integer	Required within parent
`billing_thresholds (anyOf 2)`	string	Alternative	One of:
`current_trial`	object	Optional
`current_trial.trial_offer`	string	Required within parent	Maximum length: 5000
`discounts`	JSON	Optional
`discounts (anyOf 1)`	array	Alternative
`discounts (anyOf 1)[]`	object	Each item
`discounts (anyOf 1)[].coupon`	string	Optional	Maximum length: 5000
`discounts (anyOf 1)[].discount`	string	Optional	Maximum length: 5000
`discounts (anyOf 1)[].promotion_code`	string	Optional	Maximum length: 5000
`discounts (anyOf 2)`	string	Alternative	One of:
`metadata`	object	Optional	Additional keys: see wildcard field
`metadata.*`	string	Additional keys
`price`	string	Optional	Maximum length: 5000
`price_data`	Model	Optional	Expand Update a subscription — request body — body items item price data
`quantity`	integer	Optional
`tax_rates`	JSON	Optional
`tax_rates (anyOf 1)`	array	Alternative
`tax_rates (anyOf 1)[]`	string	Each item	Maximum length: 5000
`tax_rates (anyOf 2)`	string	Alternative	One of:

Referenced models: Update a subscription — request body — body items item price data

Delete a subscription discount — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`checkout_session`	JSON	Optional
`checkout_session (anyOf 1)`	string	Alternative	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. Maximum length: 5000
`checkout_session (anyOf 2)`	null	Alternative
`customer`	JSON	Optional
`customer (anyOf 1)`	JSON	Alternative	The ID of the customer associated with this discount.
`customer (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`customer (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a customer — response body
`customer (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Delete a customer — response body
`customer (anyOf 2)`	null	Alternative
`customer_account`	JSON	Optional
`customer_account (anyOf 1)`	string	Alternative	The ID of the account representing the customer associated with this discount. Maximum length: 5000
`customer_account (anyOf 2)`	null	Alternative
`deleted`	boolean	Required within parent	Always true for a deleted object Known values: True
`id`	string	Required within parent	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. Maximum length: 5000
`invoice`	JSON	Optional
`invoice (anyOf 1)`	string	Alternative	The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. Maximum length: 5000
`invoice (anyOf 2)`	null	Alternative
`invoice_item`	JSON	Optional
`invoice_item (anyOf 1)`	string	Alternative	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. Maximum length: 5000
`invoice_item (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: discount
`promotion_code`	JSON	Optional
`promotion_code (anyOf 1)`	JSON	Alternative	The promotion code applied to create this discount.
`promotion_code (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`promotion_code (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a promotion code — response body
`promotion_code (anyOf 2)`	null	Alternative
`source`	Model	Required within parent	Expand Get Customers Customer Discount — response body — source
`start`	JSON	Required within parent
`start (anyOf 1)`	integer	Alternative	Date that the coupon was applied. Format: unix-time
`start (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`subscription`	JSON	Optional
`subscription (anyOf 1)`	string	Alternative	The subscription that this coupon is applied to, if it is applied to a particular subscription. Maximum length: 5000
`subscription (anyOf 2)`	null	Alternative
`subscription_item`	JSON	Optional
`subscription_item (anyOf 1)`	string	Alternative	The subscription item that this coupon is applied to, if it is applied to a particular subscription item. Maximum length: 5000
`subscription_item (anyOf 2)`	null	Alternative

Referenced models: Create a customer — response body, Delete a customer — response body, Get Customers Customer Discount — response body — source, Create a promotion code — response body

Pause a subscription — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating)
`application`	JSON	Optional
`application (anyOf 1)`	JSON	Alternative	ID of the Connect Application that created the subscription.
`application (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`application (anyOf 1) (anyOf 2)`	Model	Alternative	Expand PostApplicationFeesIdRefund — response body — application / object: application
`application (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Accept a quote — response body — application / value / deleted: True, object: application
`application (anyOf 2)`	null	Alternative
`application_fee_percent`	JSON	Optional
`application_fee_percent (anyOf 1)`	JSON	Alternative
`application_fee_percent (anyOf 1) (anyOf 1)`	number	Alternative	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.
`application_fee_percent (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`application_fee_percent (anyOf 2)`	null	Alternative
`automatic_tax`	Model	Required within parent	Expand Pause a subscription — response body — automatic tax
`billing_cycle_anchor`	JSON	Required within parent
`billing_cycle_anchor (anyOf 1)`	integer	Alternative	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. Format: unix-time
`billing_cycle_anchor (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`billing_cycle_anchor_config`	JSON	Optional
`billing_cycle_anchor_config (anyOf 1)`	JSON	Alternative	The fixed values used to calculate the `billing_cycle_anchor`.
`billing_cycle_anchor_config (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — billing cycle anchor config value day of month, hour, minute, month, second
`billing_cycle_anchor_config (anyOf 2)`	null	Alternative
`billing_mode`	Model	Required within parent	Expand Cancel a schedule — response body — billing mode
`billing_schedules`	array	Required within parent	Billing schedules for this subscription.
`billing_schedules[]`	Model	Each item	Expand Pause a subscription — response body — billing schedules item
`billing_thresholds`	JSON	Optional
`billing_thresholds (anyOf 1)`	JSON	Alternative	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
`billing_thresholds (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — billing thresholds value amount gte, reset billing cycle anchor
`billing_thresholds (anyOf 2)`	null	Alternative
`cancel_at`	JSON	Optional
`cancel_at (anyOf 1)`	JSON	Alternative
`cancel_at (anyOf 1) (anyOf 1)`	integer	Alternative	A date in the future at which the subscription will automatically get canceled Format: unix-time
`cancel_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cancel_at (anyOf 2)`	null	Alternative
`cancel_at_period_end`	boolean	Required within parent	Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
`canceled_at`	JSON	Optional
`canceled_at (anyOf 1)`	JSON	Alternative
`canceled_at (anyOf 1) (anyOf 1)`	integer	Alternative	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. Format: unix-time
`canceled_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`canceled_at (anyOf 2)`	null	Alternative
`cancellation_details`	JSON	Optional
`cancellation_details (anyOf 1)`	JSON	Alternative	Details about why this subscription was cancelled
`cancellation_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — cancellation details Details about why this subscription was cancelled comment, feedback, feedback option, reason
`cancellation_details (anyOf 2)`	null	Alternative
`collection_method`	string	Required within parent	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`. Known values: charge_automatically, send_invoice
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	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). Format: currency
`customer`	JSON	Required within parent	ID of the customer who owns the subscription.
`customer (anyOf 1)`	string	Alternative	Maximum length: 5000
`customer (anyOf 2)`	Model	Alternative	Expand Create a customer — response body
`customer (anyOf 3)`	Model	Alternative	Expand Delete a customer — response body
`customer_account`	JSON	Optional
`customer_account (anyOf 1)`	string	Alternative	ID of the account representing the customer who owns the subscription. Maximum length: 5000
`customer_account (anyOf 2)`	null	Alternative
`days_until_due`	JSON	Optional
`days_until_due (anyOf 1)`	JSON	Alternative
`days_until_due (anyOf 1) (anyOf 1)`	integer	Alternative	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`.
`days_until_due (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`days_until_due (anyOf 2)`	null	Alternative
`default_payment_method`	JSON	Optional
`default_payment_method (anyOf 1)`	JSON	Alternative	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_payment_method (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`default_payment_method (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a Payment Method — response body
`default_payment_method (anyOf 2)`	null	Alternative
`default_source`	JSON	Optional
`default_source (anyOf 1)`	JSON	Alternative	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_source (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`default_source (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a bank account — response body
`default_source (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Retrieve a card — customers get Customers Customer Cards Id — response body
`default_source (anyOf 1) (anyOf 4)`	Model	Alternative	Expand Create a source — response body
`default_source (anyOf 2)`	null	Alternative
`default_tax_rates`	JSON	Optional
`default_tax_rates (anyOf 1)`	array	Alternative	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.
`default_tax_rates (anyOf 1)[]`	Model	Each item	Expand Create a tax rate — response body
`default_tax_rates (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	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. Maximum length: 500
`description (anyOf 2)`	null	Alternative
`discounts`	array	Required within parent	The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
`discounts[]`	JSON	Each item
`discounts[] (anyOf 1)`	string	Alternative	Maximum length: 5000
`discounts[] (anyOf 2)`	Model	Alternative	Expand Get Customers Customer Discount — response body
`ended_at`	JSON	Optional
`ended_at (anyOf 1)`	JSON	Alternative
`ended_at (anyOf 1) (anyOf 1)`	integer	Alternative	If the subscription has ended, the date the subscription ended. Format: unix-time
`ended_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`ended_at (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`invoice_settings`	Model	Required within parent	Expand Pause a subscription — response body — invoice settings
`items`	object	Required within parent	List of subscription items, each with an attached price.
`items.data`	array	Required within parent	Details about each object.
`items.data[]`	Model	Each item	Expand Create a subscription item — response body
`items.has_more`	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
`items.object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
`items.url`	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000
`latest_invoice`	JSON	Optional
`latest_invoice (anyOf 1)`	JSON	Alternative	The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
`latest_invoice (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`latest_invoice (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Pay an invoice — response body
`latest_invoice (anyOf 2)`	null	Alternative
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`managed_payments`	JSON	Optional
`managed_payments (anyOf 1)`	JSON	Alternative	Settings for Managed Payments for this Subscription and resulting [Invoices](/api/invoices/object) and [PaymentIntents](/api/payment_intents/object).
`managed_payments (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Setup Intent — response body — managed payments value enabled
`managed_payments (anyOf 2)`	null	Alternative
`metadata`	object	Required within parent	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. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`next_pending_invoice_item_invoice`	JSON	Optional
`next_pending_invoice_item_invoice (anyOf 1)`	JSON	Alternative
`next_pending_invoice_item_invoice (anyOf 1) (anyOf 1)`	integer	Alternative	Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. Format: unix-time
`next_pending_invoice_item_invoice (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`next_pending_invoice_item_invoice (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: subscription
`on_behalf_of`	JSON	Optional
`on_behalf_of (anyOf 1)`	JSON	Alternative	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.
`on_behalf_of (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`on_behalf_of (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create an account — response body
`on_behalf_of (anyOf 2)`	null	Alternative
`pause_collection`	JSON	Optional
`pause_collection (anyOf 1)`	JSON	Alternative	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).
`pause_collection (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — pause_collection / value / behavior: keep as draft, mark uncollectible, void
`pause_collection (anyOf 2)`	null	Alternative
`payment_settings`	JSON	Optional
`payment_settings (anyOf 1)`	JSON	Alternative	Payment settings passed on to invoices created by the subscription.
`payment_settings (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method
`payment_settings (anyOf 2)`	null	Alternative
`pending_invoice_item_interval`	JSON	Optional
`pending_invoice_item_interval (anyOf 1)`	JSON	Alternative	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_invoice_item_interval (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — pending_invoice_item_interval / value / interval: day, month, week, year
`pending_invoice_item_interval (anyOf 2)`	null	Alternative
`pending_setup_intent`	JSON	Optional
`pending_setup_intent (anyOf 1)`	JSON	Alternative	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_setup_intent (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`pending_setup_intent (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Cancel a Setup Intent — response body
`pending_setup_intent (anyOf 2)`	null	Alternative
`pending_update`	JSON	Optional
`pending_update (anyOf 1)`	JSON	Alternative	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.
`pending_update (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — pending update value billing cycle anchor, cancel at period end, discount, discounts, expires at, metadata, subscription items, trial end, trial from plan
`pending_update (anyOf 2)`	null	Alternative
`presentment_details`	Model	Optional	Expand Pause a subscription — response body — presentment details
`schedule`	JSON	Optional
`schedule (anyOf 1)`	JSON	Alternative	The schedule attached to the subscription
`schedule (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`schedule (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Cancel a schedule — response body
`schedule (anyOf 2)`	null	Alternative
`start_date`	JSON	Required within parent
`start_date (anyOf 1)`	integer	Alternative	Date when the subscription was first created. The date might differ from the `created` date due to backdating. Format: unix-time
`start_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status`	string	Required within parent	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/free-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. Known values: active, canceled, incomplete, incomplete_expired, past_due, paused, trialing, unpaid
`status_details`	Model	Optional	Expand Pause a subscription — response body — status details
`test_clock`	JSON	Optional
`test_clock (anyOf 1)`	JSON	Alternative	ID of the test clock this subscription belongs to.
`test_clock (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`test_clock (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a test clock — response body
`test_clock (anyOf 2)`	null	Alternative
`transfer_data`	JSON	Optional
`transfer_data (anyOf 1)`	JSON	Alternative	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.
`transfer_data (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — transfer data value amount percent, destination
`transfer_data (anyOf 2)`	null	Alternative
`trial_end`	JSON	Optional
`trial_end (anyOf 1)`	JSON	Alternative
`trial_end (anyOf 1) (anyOf 1)`	integer	Alternative	If the subscription has a trial, the end of that trial. Format: unix-time
`trial_end (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`trial_end (anyOf 2)`	null	Alternative
`trial_settings`	JSON	Optional
`trial_settings (anyOf 1)`	JSON	Alternative	Settings related to subscription trials.
`trial_settings (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — trial settings Settings related to subscription trials end behavior
`trial_settings (anyOf 2)`	null	Alternative
`trial_start`	JSON	Optional
`trial_start (anyOf 1)`	JSON	Alternative
`trial_start (anyOf 1) (anyOf 1)`	integer	Alternative	If the subscription has a trial, the beginning of that trial. Format: unix-time
`trial_start (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`trial_start (anyOf 2)`	null	Alternative

Pause a subscription — response body — automatic tax

Field	Type	Presence	Description and constraints
`$`	object	Root
`disabled_reason`	JSON	Optional
`disabled_reason (anyOf 1)`	string	Alternative	If Stripe disabled automatic tax, this enum describes why. Known values: requires_location_inputs
`disabled_reason (anyOf 2)`	null	Alternative
`enabled`	boolean	Required within parent	Whether Stripe automatically computes tax on this subscription.
`liability`	JSON	Optional
`liability (anyOf 1)`	JSON	Alternative	The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
`liability (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — issuer
`liability (anyOf 2)`	null	Alternative

Referenced models: Pay an invoice — response body — issuer

Pause a subscription — response body — billing cycle anchor config value day of month, hour, minute, month, second

Field	Type	Presence	Description and constraints
`$`	object	Root
`day_of_month`	JSON	Required within parent
`day_of_month (anyOf 1)`	integer	Alternative	The day of the month of the billing_cycle_anchor.
`day_of_month (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour`	JSON	Optional
`hour (anyOf 1)`	JSON	Alternative
`hour (anyOf 1) (anyOf 1)`	integer	Alternative	The hour of the day of the billing_cycle_anchor.
`hour (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hour (anyOf 2)`	null	Alternative
`minute`	JSON	Optional
`minute (anyOf 1)`	JSON	Alternative
`minute (anyOf 1) (anyOf 1)`	integer	Alternative	The minute of the hour of the billing_cycle_anchor.
`minute (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`minute (anyOf 2)`	null	Alternative
`month`	JSON	Optional
`month (anyOf 1)`	JSON	Alternative
`month (anyOf 1) (anyOf 1)`	integer	Alternative	The month to start full cycle billing periods.
`month (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`month (anyOf 2)`	null	Alternative
`second`	JSON	Optional
`second (anyOf 1)`	JSON	Alternative
`second (anyOf 1) (anyOf 1)`	integer	Alternative	The second of the minute of the billing_cycle_anchor.
`second (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`second (anyOf 2)`	null	Alternative

Pause a subscription — response body — billing schedules item

Field	Type	Presence	Description and constraints
`$`	object	Root	Sets the billing schedule for the subscription.
`applies_to`	JSON	Optional
`applies_to (anyOf 1)`	array	Alternative	Specifies which subscription items the billing schedule applies to.
`applies_to (anyOf 1)[]`	Model	Each item	Expand Pause a subscription — response body — billing schedules item applies to array item
`applies_to (anyOf 2)`	null	Alternative
`bill_until`	Model	Required within parent	Expand Pause a subscription — response body — billing schedules item bill until
`key`	string	Required within parent	Unique identifier for the billing schedule. Maximum length: 5000

Referenced models: Pause a subscription — response body — billing schedules item applies to array item, Pause a subscription — response body — billing schedules item bill until

Pause a subscription — response body — billing schedules item applies to array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the entities that the billing schedule applies to.
`price`	JSON	Optional
`price (anyOf 1)`	JSON	Alternative	The billing schedule will apply to the subscription item with the given price ID.
`price (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`price (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a price — response body
`price (anyOf 2)`	null	Alternative
`type`	string	Required within parent	Controls which subscription items the billing schedule applies to. Known values: price

Referenced models: Create a price — response body

Pause a subscription — response body — billing schedules item bill until

Field	Type	Presence	Description and constraints
`$`	object	Root	Specifies the end of billing period.
`computed_timestamp`	JSON	Required within parent
`computed_timestamp (anyOf 1)`	integer	Alternative	The timestamp the billing schedule will apply until. Format: unix-time
`computed_timestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`duration`	JSON	Optional
`duration (anyOf 1)`	JSON	Alternative	Specifies the billing period.
`duration (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — billing_schedules / item / bill_until / duration / Specifies the billing period / interval: day, month, week, year
`duration (anyOf 2)`	null	Alternative
`timestamp`	JSON	Optional
`timestamp (anyOf 1)`	JSON	Alternative
`timestamp (anyOf 1) (anyOf 1)`	integer	Alternative	If specified, the billing schedule will apply until the specified timestamp. Format: unix-time
`timestamp (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`timestamp (anyOf 2)`	null	Alternative
`type`	string	Required within parent	Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`. Known values: duration, timestamp

Referenced models: Pause a subscription — response body — billing_schedules / item / bill_until / duration / Specifies the billing period / interval: day, month, week, year

Pause a subscription — response body — billing thresholds value amount gte, reset billing cycle anchor

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount_gte`	JSON	Optional
`amount_gte (anyOf 1)`	JSON	Alternative
`amount_gte (anyOf 1) (anyOf 1)`	integer	Alternative	Monetary threshold that triggers the subscription to create an invoice
`amount_gte (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount_gte (anyOf 2)`	null	Alternative
`reset_billing_cycle_anchor`	JSON	Optional
`reset_billing_cycle_anchor (anyOf 1)`	boolean	Alternative	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`.
`reset_billing_cycle_anchor (anyOf 2)`	null	Alternative

Pause a subscription — response body — billing_schedules / item / bill_until / duration / Specifies the billing period / interval: day, month, week, year

Field	Type	Presence	Description and constraints
`$`	object	Root	Configures the `bill_until` date based on the provided `interval` and `interval_count`.
`interval`	string	Required within parent	Specifies billing duration. Either `day`, `week`, `month` or `year`. Known values: day, month, week, year
`interval_count`	JSON	Optional
`interval_count (anyOf 1)`	JSON	Alternative
`interval_count (anyOf 1) (anyOf 1)`	integer	Alternative	The multiplier applied to the interval.
`interval_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`interval_count (anyOf 2)`	null	Alternative

Pause a subscription — response body — cancellation details Details about why this subscription was cancelled comment, feedback, feedback option, reason

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative	Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. Maximum length: 5000
`comment (anyOf 2)`	null	Alternative
`feedback`	JSON	Optional
`feedback (anyOf 1)`	string	Alternative	The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. Known values: customer_service, low_quality, missing_features, other, switched_service, too_complex, too_expensive, unused
`feedback (anyOf 2)`	null	Alternative
`feedback_option`	JSON	Optional
`feedback_option (anyOf 1)`	JSON	Alternative	Customized feedback options that provide deeper insight into why the subscription was canceled, if the subscription was canceled explicitly by the user.
`feedback_option (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`feedback_option (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a feedback option — response body
`feedback_option (anyOf 2)`	null	Alternative
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative	Why this subscription was canceled. Known values: canceled_by_retention_policy, cancellation_requested, payment_disputed, payment_failed
`reason (anyOf 2)`	null	Alternative

Referenced models: Create a feedback option — response body

Pause a subscription — response body — invoice settings

Field	Type	Presence	Description and constraints
`$`	object	Root
`account_tax_ids`	JSON	Optional
`account_tax_ids (anyOf 1)`	array	Alternative	The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
`account_tax_ids (anyOf 1)[]`	JSON	Each item
`account_tax_ids (anyOf 1)[] (anyOf 1)`	string	Alternative	Maximum length: 5000
`account_tax_ids (anyOf 1)[] (anyOf 2)`	Model	Alternative	Expand Create a tax ID — response body
`account_tax_ids (anyOf 1)[] (anyOf 3)`	Model	Alternative	Expand Delete a tax ID — response body
`account_tax_ids (anyOf 2)`	null	Alternative
`custom_fields`	JSON	Optional
`custom_fields (anyOf 1)`	array	Alternative	A list of up to 4 custom fields to be displayed on the invoice.
`custom_fields (anyOf 1)[]`	Model	Each item	Expand Pay an invoice — response body — custom fields Custom fields displayed on the invoice item
`custom_fields (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`description (anyOf 2)`	null	Alternative
`footer`	JSON	Optional
`footer (anyOf 1)`	string	Alternative	Footer to be displayed on the invoice. Maximum length: 5000
`footer (anyOf 2)`	null	Alternative
`issuer`	Model	Required within parent	Expand Pay an invoice — response body — issuer

Referenced models: Pay an invoice — response body — issuer, Delete a tax ID — response body, Pay an invoice — response body — custom fields Custom fields displayed on the invoice item, Create a tax ID — response body

Pause a subscription — response body — pause_collection / value / behavior: keep as draft, mark uncollectible, void

Field	Type	Presence	Description and constraints
`$`	object	Root	The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.
`behavior`	string	Required within parent	The payment collection behavior for this subscription while paused. Known values: keep_as_draft, mark_uncollectible, void
`resumes_at`	JSON	Optional
`resumes_at (anyOf 1)`	JSON	Alternative
`resumes_at (anyOf 1) (anyOf 1)`	integer	Alternative	The time after which the subscription will resume collecting payments. Format: unix-time
`resumes_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`resumes_at (anyOf 2)`	null	Alternative

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method

Field	Type	Presence	Description and constraints
`$`	object	Root
`payment_method_options`	JSON	Optional
`payment_method_options (anyOf 1)`	JSON	Alternative	Payment-method-specific configuration to provide to invoices created by the subscription.
`payment_method_options (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account
`payment_method_options (anyOf 2)`	null	Alternative
`payment_method_types`	JSON	Optional
`payment_method_types (anyOf 1)`	array	Alternative	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](https://dashboard.stripe.com/settings/billing/invoice).
`payment_method_types (anyOf 1)[]`	string	Each item	Known values: ach_credit_transfer, ach_debit, acss_debit, affirm, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, jp_credit_transfer, kakao_pay, klarna, konbini, kr_card, link, mb_way, multibanco, naver_pay, nz_bank_account, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, satispay, sepa_credit_transfer, sepa_debit, sofort, swish, twint, upi, us_bank_account, wechat_pay
`payment_method_types (anyOf 2)`	null	Alternative
`save_default_payment_method`	JSON	Optional
`save_default_payment_method (anyOf 1)`	string	Alternative	Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. Known values: off, on_subscription
`save_default_payment_method (anyOf 2)`	null	Alternative

Referenced models: Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account

Field	Type	Presence	Description and constraints
`$`	object	Root
`acss_debit`	JSON	Optional
`acss_debit (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
`acss_debit (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits
`acss_debit (anyOf 2)`	null	Alternative
`bancontact`	JSON	Optional
`bancontact (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
`bancontact (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / bancontact / value / preferred_language: de, en, fr, nl
`bancontact (anyOf 2)`	null	Alternative
`billie`	JSON	Optional
`billie (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Billie payment method options to pass to invoices created by the subscription.
`billie (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details
`billie (anyOf 2)`	null	Alternative
`blik`	JSON	Optional
`blik (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Blik payment method options to pass to invoices created by the subscription.
`blik (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account blik value mandate options
`blik (anyOf 2)`	null	Alternative
`card`	JSON	Optional
`card (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
`card (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value mandate options, network, request three d secure
`card (anyOf 2)`	null	Alternative
`customer_balance`	JSON	Optional
`customer_balance (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
`customer_balance (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type
`customer_balance (anyOf 2)`	null	Alternative
`konbini`	JSON	Optional
`konbini (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
`konbini (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Payment Method — response body — zip
`konbini (anyOf 2)`	null	Alternative
`payto`	JSON	Optional
`payto (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
`payto (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options
`payto (anyOf 2)`	null	Alternative
`pix`	JSON	Optional
`pix (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
`pix (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value expires after seconds, mandate options
`pix (anyOf 2)`	null	Alternative
`sepa_debit`	JSON	Optional
`sepa_debit (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
`sepa_debit (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Payment Method — response body — zip
`sepa_debit (anyOf 2)`	null	Alternative
`upi`	JSON	Optional
`upi (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
`upi (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account upi mandate options
`upi (anyOf 2)`	null	Alternative
`us_bank_account`	JSON	Optional
`us_bank_account (anyOf 1)`	JSON	Alternative	This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
`us_bank_account (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits
`us_bank_account (anyOf 2)`	null	Alternative

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details

Field	Type	Presence	Description and constraints
`$`	object	Root
`company_details`	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account blik value mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`mandate_options`	Model	Optional	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account blik value mandate options mandate options

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account blik value mandate options mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`expires_at`	JSON	Optional
`expires_at (anyOf 1)`	JSON	Alternative
`expires_at (anyOf 1) (anyOf 1)`	integer	Alternative	Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite. Format: unix-time
`expires_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`expires_at (anyOf 2)`	null	Alternative

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value mandate options, network, request three d secure

Field	Type	Presence	Description and constraints
`$`	object	Root
`mandate_options`	Model	Optional	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value mandate options, network, request three d secure mandate options
`network`	JSON	Optional
`network (anyOf 1)`	string	Alternative	Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. Known values: amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, link, mastercard, unionpay, unknown, visa
`network (anyOf 2)`	null	Alternative
`request_three_d_secure`	JSON	Optional
`request_three_d_secure (anyOf 1)`	string	Alternative	We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). 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](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. Known values: any, automatic, challenge
`request_three_d_secure (anyOf 2)`	null	Alternative

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value mandate options, network, request three d secure mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Optional
`amount (anyOf 1)`	JSON	Alternative
`amount (anyOf 1) (anyOf 1)`	integer	Alternative	Amount to be charged for future payments, specified in the presentment currency.
`amount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount (anyOf 2)`	null	Alternative
`amount_type`	JSON	Optional
`amount_type (anyOf 1)`	string	Alternative	One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. Known values: fixed, maximum
`amount_type (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	A description of the mandate or subscription that is meant to be displayed to the customer. Maximum length: 200
`description (anyOf 2)`	null	Alternative

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value expires after seconds, mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`expires_after_seconds`	JSON	Optional
`expires_after_seconds (anyOf 1)`	integer	Alternative	The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
`expires_after_seconds (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`mandate_options`	Model	Optional	Expand Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value expires after seconds, mandate options mandate options

Pause a subscription — response body — payment settings value payment method options, payment method types, save default payment method payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value expires after seconds, mandate options mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Optional
`amount (anyOf 1)`	JSON	Alternative
`amount (anyOf 1) (anyOf 1)`	integer	Alternative	Amount to be charged for future payments.
`amount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount (anyOf 2)`	null	Alternative
`amount_includes_iof`	JSON	Optional
`amount_includes_iof (anyOf 1)`	string	Alternative	Determines if the amount includes the IOF tax. Known values: always, never
`amount_includes_iof (anyOf 2)`	null	Alternative
`end_date`	JSON	Optional
`end_date (anyOf 1)`	string	Alternative	Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. Maximum length: 5000
`end_date (anyOf 2)`	null	Alternative
`payment_schedule`	JSON	Optional
`payment_schedule (anyOf 1)`	string	Alternative	Schedule at which the future payments will be charged. Known values: halfyearly, monthly, quarterly, weekly, yearly
`payment_schedule (anyOf 2)`	null	Alternative

Pause a subscription — response body — pending update value billing cycle anchor, cancel at period end, discount, discounts, expires at, metadata, subscription items, trial end, trial from plan

Field	Type	Presence	Description and constraints
`$`	object	Root	Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
`billing_cycle_anchor`	JSON	Optional
`billing_cycle_anchor (anyOf 1)`	JSON	Alternative
`billing_cycle_anchor (anyOf 1) (anyOf 1)`	integer	Alternative	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. Format: unix-time
`billing_cycle_anchor (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`billing_cycle_anchor (anyOf 2)`	null	Alternative
`cancel_at_period_end`	JSON	Optional
`cancel_at_period_end (anyOf 1)`	boolean	Alternative	Indicates whether this subscription should cancel at the end of the current period if the update is applied.
`cancel_at_period_end (anyOf 2)`	null	Alternative
`discount`	JSON	Optional
`discount (anyOf 1)`	JSON	Alternative	The pending subscription-level discount that will be applied when the pending update is applied.
`discount (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Get Customers Customer Discount — response body
`discount (anyOf 2)`	null	Alternative
`discounts`	JSON	Optional
`discounts (anyOf 1)`	array	Alternative	The discounts that will be applied to the subscription when the pending update is applied. Use `expand[]=discounts` to expand each discount.
`discounts (anyOf 1)[]`	JSON	Each item
`discounts (anyOf 1)[] (anyOf 1)`	string	Alternative	Maximum length: 5000
`discounts (anyOf 1)[] (anyOf 2)`	Model	Alternative	Expand Get Customers Customer Discount — response body
`discounts (anyOf 2)`	null	Alternative
`expires_at`	JSON	Required within parent
`expires_at (anyOf 1)`	integer	Alternative	The point after which the changes reflected by this update will be discarded and no longer applied. Format: unix-time
`expires_at (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	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. Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys	Maximum length: 500
`metadata (anyOf 2)`	null	Alternative
`subscription_items`	JSON	Optional
`subscription_items (anyOf 1)`	array	Alternative	List of subscription items, each with an attached plan, that will be set if the update is applied.
`subscription_items (anyOf 1)[]`	Model	Each item	Expand Create a subscription item — response body
`subscription_items (anyOf 2)`	null	Alternative
`trial_end`	JSON	Optional
`trial_end (anyOf 1)`	JSON	Alternative
`trial_end (anyOf 1) (anyOf 1)`	integer	Alternative	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. Format: unix-time
`trial_end (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`trial_end (anyOf 2)`	null	Alternative
`trial_from_plan`	JSON	Optional
`trial_from_plan (anyOf 1)`	boolean	Alternative	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/free-trials) to learn more.
`trial_from_plan (anyOf 2)`	null	Alternative

Referenced models: Get Customers Customer Discount — response body, Create a subscription item — response body

Pause a subscription — response body — pending_invoice_item_interval / value / interval: day, month, week, year

Field	Type	Presence	Description and constraints
`$`	object	Root
`interval`	string	Required within parent	Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. Known values: day, month, week, year
`interval_count`	JSON	Required within parent
`interval_count (anyOf 1)`	integer	Alternative	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).
`interval_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Pause a subscription — response body — presentment details

Field	Type	Presence	Description and constraints
`$`	object	Root
`presentment_currency`	string	Required within parent	Currency used for customer payments. Maximum length: 5000

Pause a subscription — response body — status details

Field	Type	Presence	Description and constraints
`$`	object	Root	Describes changes to the subscription's status.
`paused`	Model	Required within parent	Expand Pause a subscription — response body — status details paused

Referenced models: Pause a subscription — response body — status details paused

Pause a subscription — response body — status details paused

Field	Type	Presence	Description and constraints
`$`	object	Root	Indicates when and why the subscription transitioned to the paused status.
`subscription`	Model	Required within parent	Expand Pause a subscription — response body — status details paused subscription
`transitioned_at`	JSON	Required within parent
`transitioned_at (anyOf 1)`	integer	Alternative	Unix timestamp in seconds of when the subscription status transitioned to `paused`. Format: unix-time
`transitioned_at (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`type`	string	Required within parent	The type of pause. Known values: subscription

Referenced models: Pause a subscription — response body — status details paused subscription

Pause a subscription — response body — status details paused subscription

Field	Type	Presence	Description and constraints
`$`	object	Root	Information on the `type=subscription` pause.
`type`	string	Required within parent	The reason that the subscription was paused. Known values: final_payment_failure, first_payment_failure, pause_requested, system, trial_end_without_payment_method

Pause a subscription — response body — transfer data value amount percent, destination

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount_percent`	JSON	Optional
`amount_percent (anyOf 1)`	JSON	Alternative
`amount_percent (anyOf 1) (anyOf 1)`	number	Alternative	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 destination account. By default, the entire amount is transferred to the destination.
`amount_percent (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount_percent (anyOf 2)`	null	Alternative
`destination`	JSON	Required within parent	The account where funds from the payment will be transferred to upon payment success.
`destination (anyOf 1)`	string	Alternative	Maximum length: 5000
`destination (anyOf 2)`	Model	Alternative	Expand Create an account — response body

Referenced models: Create an account — response body

Pause a subscription — response body — trial settings Settings related to subscription trials end behavior

Field	Type	Presence	Description and constraints
`$`	object	Root	Configures how this subscription behaves during the trial period.
`end_behavior`	Model	Required within parent	Expand Pause a subscription — response body — trial settings Settings related to subscription trials end behavior end behavior

Referenced models: Pause a subscription — response body — trial settings Settings related to subscription trials end behavior end behavior

Pause a subscription — response body — trial settings Settings related to subscription trials end behavior end behavior

Field	Type	Presence	Description and constraints
`$`	object	Root	Defines how a subscription behaves when a trial ends.
`billing_cycle_anchor`	JSON	Optional
`billing_cycle_anchor (anyOf 1)`	string	Alternative	Indicates how the subscription's billing cycle anchor is reset when a trial ends. If not set, the default is `now`. Known values: now, unchanged
`billing_cycle_anchor (anyOf 2)`	null	Alternative
`missing_payment_method`	string	Required within parent	Indicates how the subscription should change when the trial ends if the user did not provide a payment method. Known values: cancel, create_invoice, pause

Update a subscription — request body — body / payment_settings / payment_method_options / card / request_three_d_secure: any, automatic, challenge

Field	Type	Presence	Description and constraints
`$`	object	Root
`mandate_options`	object	Optional
`mandate_options.amount`	integer	Optional
`mandate_options.amount_type`	string	Optional	One of: fixed, maximum
`mandate_options.description`	string	Optional	Maximum length: 200
`network`	string	Optional	One of: amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, link, mastercard, unionpay, unknown, visa Maximum length: 5000
`request_three_d_secure`	string	Optional	One of: any, automatic, challenge

Update a subscription — request body — body add invoice items item

Field	Type	Presence	Description and constraints
`$`	object	Root
`discountable`	boolean	Optional
`discounts`	array	Optional
`discounts[]`	object	Each item
`discounts[].coupon`	string	Optional	Maximum length: 5000
`discounts[].discount`	string	Optional	Maximum length: 5000
`discounts[].promotion_code`	string	Optional	Maximum length: 5000
`metadata`	object	Optional	Additional keys: see wildcard field
`metadata.*`	string	Additional keys
`period`	object	Optional
`period.end`	object	Required within parent
`period.end.timestamp`	integer	Optional	Format: unix-time
`period.end.type`	string	Required within parent	One of: min_item_period_end, timestamp
`period.start`	object	Required within parent
`period.start.timestamp`	integer	Optional	Format: unix-time
`period.start.type`	string	Required within parent	One of: max_item_period_start, now, timestamp
`price`	string	Optional	Maximum length: 5000
`price_data`	object	Optional
`price_data.currency`	string	Required within parent	Format: currency
`price_data.product`	string	Required within parent	Maximum length: 5000
`price_data.tax_behavior`	string	Optional	One of: exclusive, inclusive, unspecified
`price_data.unit_amount`	integer	Optional
`price_data.unit_amount_decimal`	string	Optional	Format: decimal
`quantity`	integer	Optional
`tax_rates`	JSON	Optional
`tax_rates (anyOf 1)`	array	Alternative
`tax_rates (anyOf 1)[]`	string	Each item	Maximum length: 5000
`tax_rates (anyOf 2)`	string	Alternative	One of:

Update a subscription — request body — body billing schedules array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`applies_to`	array	Optional
`applies_to[]`	object	Each item
`applies_to[].price`	string	Optional	Maximum length: 5000
`applies_to[].type`	string	Required within parent	One of: price
`bill_until`	object	Optional
`bill_until.duration`	object	Optional
`bill_until.duration.interval`	string	Required within parent	One of: day, month, week, year
`bill_until.duration.interval_count`	integer	Optional
`bill_until.timestamp`	integer	Optional	Format: unix-time
`bill_until.type`	string	Required within parent	One of: duration, timestamp
`key`	string	Optional	Maximum length: 200

Update a subscription — request body — body invoice settings

Field	Type	Presence	Description and constraints
`$`	object	Root	All invoices will be billed using the specified settings.
`account_tax_ids`	JSON	Optional
`account_tax_ids (anyOf 1)`	array	Alternative
`account_tax_ids (anyOf 1)[]`	string	Each item	Maximum length: 5000
`account_tax_ids (anyOf 2)`	string	Alternative	One of:
`custom_fields`	JSON	Optional
`custom_fields (anyOf 1)`	array	Alternative
`custom_fields (anyOf 1)[]`	object	Each item
`custom_fields (anyOf 1)[].name`	string	Required within parent	Maximum length: 40
`custom_fields (anyOf 1)[].value`	string	Required within parent	Maximum length: 140
`custom_fields (anyOf 2)`	string	Alternative	One of:
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Maximum length: 1500
`description (anyOf 2)`	string	Alternative	One of:
`footer`	JSON	Optional
`footer (anyOf 1)`	string	Alternative	Maximum length: 5000
`footer (anyOf 2)`	string	Alternative	One of:
`issuer`	object	Optional
`issuer.account`	string	Optional
`issuer.type`	string	Required within parent	One of: account, self

Update a subscription — request body — body items item

Field	Type	Presence	Description and constraints
`$`	object	Root
`billing_thresholds`	JSON	Optional
`billing_thresholds (anyOf 1)`	object	Alternative
`billing_thresholds (anyOf 1).usage_gte`	integer	Required within parent
`billing_thresholds (anyOf 2)`	string	Alternative	One of:
`clear_usage`	boolean	Optional
`current_trial`	object	Optional
`current_trial.trial_offer`	string	Required within parent	Maximum length: 5000
`deleted`	boolean	Optional
`discounts`	JSON	Optional
`discounts (anyOf 1)`	array	Alternative
`discounts (anyOf 1)[]`	object	Each item
`discounts (anyOf 1)[].coupon`	string	Optional	Maximum length: 5000
`discounts (anyOf 1)[].discount`	string	Optional	Maximum length: 5000
`discounts (anyOf 1)[].promotion_code`	string	Optional	Maximum length: 5000
`discounts (anyOf 2)`	string	Alternative	One of:
`id`	string	Optional	Maximum length: 5000
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys
`metadata (anyOf 2)`	string	Alternative	One of:
`price`	string	Optional	Maximum length: 5000
`price_data`	Model	Optional	Expand Update a subscription — request body — body items item price data
`quantity`	integer	Optional
`tax_rates`	JSON	Optional
`tax_rates (anyOf 1)`	array	Alternative
`tax_rates (anyOf 1)[]`	string	Each item	Maximum length: 5000
`tax_rates (anyOf 2)`	string	Alternative	One of:

Referenced models: Update a subscription — request body — body items item price data

Update a subscription — request body — body items item price data

Field	Type	Presence	Description and constraints
`$`	object	Root
`currency`	string	Required within parent	Format: currency
`product`	string	Required within parent	Maximum length: 5000
`recurring`	object	Required within parent
`recurring.interval`	string	Required within parent	One of: day, month, week, year
`recurring.interval_count`	integer	Optional
`tax_behavior`	string	Optional	One of: exclusive, inclusive, unspecified
`unit_amount`	integer	Optional
`unit_amount_decimal`	string	Optional	Format: decimal

Update a subscription — request body — body payment settings

Field	Type	Presence	Description and constraints
`$`	object	Root	Payment settings to pass to invoices created by the subscription.
`payment_method_options`	Model	Optional	Expand Update a subscription — request body — body payment settings payment method options
`payment_method_types`	JSON	Optional
`payment_method_types (anyOf 1)`	array	Alternative
`payment_method_types (anyOf 1)[]`	string	Each item	One of: ach_credit_transfer, ach_debit, acss_debit, affirm, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, jp_credit_transfer, kakao_pay, klarna, konbini, kr_card, link, mb_way, multibanco, naver_pay, nz_bank_account, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, satispay, sepa_credit_transfer, sepa_debit, sofort, swish, twint, upi, us_bank_account, wechat_pay
`payment_method_types (anyOf 2)`	string	Alternative	One of:
`save_default_payment_method`	string	Optional	One of: off, on_subscription

Referenced models: Update a subscription — request body — body payment settings payment method options

Update a subscription — request body — body payment settings payment method options

Field	Type	Presence	Description and constraints
`$`	object	Root
`acss_debit`	JSON	Optional
`acss_debit (anyOf 1)`	object	Alternative
`acss_debit (anyOf 1).mandate_options`	object	Optional
`acss_debit (anyOf 1).mandate_options.transaction_type`	string	Optional	One of: business, personal
`acss_debit (anyOf 1).verification_method`	string	Optional	One of: automatic, instant, microdeposits
`acss_debit (anyOf 2)`	string	Alternative	One of:
`bancontact`	JSON	Optional
`bancontact (anyOf 1)`	object	Alternative
`bancontact (anyOf 1).preferred_language`	string	Optional	One of: de, en, fr, nl
`bancontact (anyOf 2)`	string	Alternative	One of:
`billie`	JSON	Optional
`billie (anyOf 1)`	Model	Alternative	Expand Update a subscription — request body — body payment settings payment method options billie company details
`billie (anyOf 2)`	string	Alternative	One of:
`blik`	JSON	Optional
`blik (anyOf 1)`	object	Alternative
`blik (anyOf 1).mandate_options`	object	Optional
`blik (anyOf 1).mandate_options.expires_at`	integer	Optional	Format: unix-time
`blik (anyOf 2)`	string	Alternative	One of:
`card`	JSON	Optional
`card (anyOf 1)`	Model	Alternative	Expand Update a subscription — request body — body / payment_settings / payment_method_options / card / request_three_d_secure: any, automatic, challenge
`card (anyOf 2)`	string	Alternative	One of:
`customer_balance`	JSON	Optional
`customer_balance (anyOf 1)`	object	Alternative
`customer_balance (anyOf 1).bank_transfer`	object	Optional
`customer_balance (anyOf 1).bank_transfer.eu_bank_transfer`	object	Optional
`customer_balance (anyOf 1).bank_transfer.eu_bank_transfer.country`	string	Required within parent	Maximum length: 5000
`customer_balance (anyOf 1).bank_transfer.type`	string	Optional
`customer_balance (anyOf 1).funding_type`	string	Optional
`customer_balance (anyOf 2)`	string	Alternative	One of:
`konbini`	JSON	Optional
`konbini (anyOf 1)`	object	Alternative
`konbini (anyOf 2)`	string	Alternative	One of:
`payto`	JSON	Optional
`payto (anyOf 1)`	object	Alternative
`payto (anyOf 1).mandate_options`	object	Optional
`payto (anyOf 1).mandate_options.amount`	integer	Optional
`payto (anyOf 1).mandate_options.purpose`	string	Optional	One of: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility
`payto (anyOf 2)`	string	Alternative	One of:
`pix`	JSON	Optional
`pix (anyOf 1)`	object	Alternative
`pix (anyOf 1).expires_after_seconds`	integer	Optional
`pix (anyOf 1).mandate_options`	object	Optional
`pix (anyOf 1).mandate_options.amount`	integer	Optional
`pix (anyOf 1).mandate_options.amount_includes_iof`	string	Optional	One of: always, never
`pix (anyOf 1).mandate_options.end_date`	string	Optional	Maximum length: 5000
`pix (anyOf 1).mandate_options.payment_schedule`	string	Optional	One of: halfyearly, monthly, quarterly, weekly, yearly
`pix (anyOf 2)`	string	Alternative	One of:
`sepa_debit`	JSON	Optional
`sepa_debit (anyOf 1)`	object	Alternative
`sepa_debit (anyOf 2)`	string	Alternative	One of:
`upi`	JSON	Optional
`upi (anyOf 1)`	object	Alternative
`upi (anyOf 1).mandate_options`	object	Optional
`upi (anyOf 1).mandate_options.amount`	integer	Optional
`upi (anyOf 1).mandate_options.amount_type`	string	Optional	One of: fixed, maximum
`upi (anyOf 1).mandate_options.description`	string	Optional	Maximum length: 20
`upi (anyOf 1).mandate_options.end_date`	integer	Optional	Format: unix-time
`upi (anyOf 2)`	string	Alternative	One of:
`us_bank_account`	JSON	Optional
`us_bank_account (anyOf 1)`	Model	Alternative	Expand Create an invoice — request body — body / payment_settings / payment_method_options / us_bank_account / verification_method: automatic, instant, microdeposits
`us_bank_account (anyOf 2)`	string	Alternative	One of:

Referenced models: Update a subscription — request body — body payment settings payment method options billie company details, Update a subscription — request body — body / payment_settings / payment_method_options / card / request_three_d_secure: any, automatic, challenge, Create an invoice — request body — body / payment_settings / payment_method_options / us_bank_account / verification_method: automatic, instant, microdeposits

Update a subscription — request body — body payment settings payment method options billie company details

Field	Type	Presence	Description and constraints
`$`	object	Root
`company_details`	JSON	Optional
`company_details (anyOf 1)`	Model	Alternative	Expand Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat
`company_details (anyOf 2)`	string	Alternative	One of:

Referenced models: Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat

Report an issue with this page