Stripe · Schema
PostCustomersCustomerSubscriptionsRequest
CommerceFinancial ServicesFintechPaymentsT1StripeAgentic CommercePoint-of-SalePayment Processing
Properties
| Name | Type | Description |
|---|---|---|
| add_invoice_items | array | 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 | 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 a |
| automatic_tax | object | Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. |
| backdate_start_date | integer | For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. C |
| billing_cycle_anchor | integer | A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with |
| billing_thresholds | object | Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. |
| cancel_at | integer | 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 dur |
| cancel_at_period_end | boolean | Boolean indicating whether this subscription should cancel at the end of the current period. |
| 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. W |
| coupon | string | The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. |
| 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). |
| 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 u |
| 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_p |
| default_tax_rates | object | 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. |
| expand | array | Specifies which fields in the response should be expanded. |
| items | array | A list of up to 20 subscription items, each with an attached price. |
| metadata | object | Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individu |
| off_session | boolean | Indicates if a customer is on or off-session while an invoice payment is attempted. |
| payment_behavior | string | Only applies to subscriptions with `collection_method=charge_automatically`. Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subsc |
| payment_settings | object | Payment settings to pass to invoices created by the subscription. |
| pending_invoice_item_interval | object | Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the |
| promotion_code | string | The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. |
| proration_behavior | string | Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_proration |
| 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 | object | 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 |
| 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 w |
| 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 p |
| trial_settings | object | Settings related to subscription trials. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-post-customers-customer-subscriptions-request-schema.json",
"title": "PostCustomersCustomerSubscriptionsRequest",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/stripe-customers-api-openapi.yml#/components/schemas/PostCustomersCustomerSubscriptionsRequest",
"type": "object",
"properties": {
"add_invoice_items": {
"description": "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.",
"items": {
"properties": {
"price": {
"maxLength": 5000,
"type": "string"
},
"price_data": {
"properties": {
"currency": {
"type": "string"
},
"product": {
"maxLength": 5000,
"type": "string"
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive",
"unspecified"
],
"type": "string"
},
"unit_amount": {
"type": "integer"
},
"unit_amount_decimal": {
"format": "decimal",
"type": "string"
}
},
"required": [
"currency",
"product"
],
"title": "one_time_price_data_with_negative_amounts",
"type": "object"
},
"quantity": {
"type": "integer"
},
"tax_rates": {
"anyOf": [
{
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
{
"enum": [
""
],
"type": "string"
}
]
}
},
"title": "add_invoice_item_entry",
"type": "object"
},
"type": "array"
},
"application_fee_percent": {
"description": "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).",
"type": "number"
},
"automatic_tax": {
"description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
"type": "object"
},
"backdate_start_date": {
"description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.",
"format": "unix-time",
"type": "integer"
},
"billing_cycle_anchor": {
"description": "A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine 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",
"type": "integer",
"x-stripeBypassValidation": true
},
"billing_thresholds": {
"anyOf": [
{
"properties": {
"amount_gte": {
"type": "integer"
},
"reset_billing_cycle_anchor": {
"type": "boolean"
}
},
"title": "billing_thresholds_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds."
},
"cancel_at": {
"description": "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.",
"format": "unix-time",
"type": "integer"
},
"cancel_at_period_end": {
"description": "Boolean indicating whether this subscription should cancel at the end of the current period.",
"type": "boolean"
},
"collection_method": {
"description": "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`.",
"enum": [
"charge_automatically",
"send_invoice"
],
"type": "string"
},
"coupon": {
"description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.",
"maxLength": 5000,
"type": "string"
},
"currency": {
"description": "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).",
"type": "string"
},
"days_until_due": {
"description": "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`.",
"type": "integer"
},
"default_payment_method": {
"description": "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://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
"maxLength": 5000,
"type": "string"
},
"default_source": {
"description": "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://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
"maxLength": 5000,
"type": "string"
},
"default_tax_rates": {
"anyOf": [
{
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "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."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
"items": {
"properties": {
"billing_thresholds": {
"anyOf": [
{
"properties": {
"usage_gte": {
"type": "integer"
}
},
"required": [
"usage_gte"
],
"title": "item_billing_thresholds_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"price": {
"maxLength": 5000,
"type": "string"
},
"price_data": {
"properties": {
"currency": {
"type": "string"
},
"product": {
"maxLength": 5000,
"type": "string"
},
"recurring": {
"properties": {
"interval": {
"enum": [
"day",
"month",
"week",
"year"
],
"type": "string"
},
"interval_count": {
"type": "integer"
}
},
"required": [
"interval"
],
"title": "recurring_adhoc",
"type": "object"
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive",
"unspecified"
],
"type": "string"
},
"unit_amount": {
"type": "integer"
},
"unit_amount_decimal": {
"format": "decimal",
"type": "string"
}
},
"required": [
"currency",
"product",
"recurring"
],
"title": "recurring_price_data",
"type": "object"
},
"quantity": {
"type": "integer"
},
"tax_rates": {
"anyOf": [
{
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
{
"enum": [
""
],
"type": "string"
}
]
}
},
"title": "subscription_item_create_params",
"type": "object"
},
"type": "array"
},
"metadata": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "Set of [key-value pairs](https://stripe.com/docs/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": {
"description": "Indicates if a customer is on or off-session while an invoice payment is attempted.",
"type": "boolean"
},
"payment_behavior": {
"description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.",
"enum": [
"allow_incomplete",
"default_incomplete",
"error_if_incomplete",
"pending_if_incomplete"
],
"type": "string"
},
"payment_settings": {
"description": "Payment settings to pass to invoices created by the subscription.",
"properties": {
"payment_method_options": {
"properties": {
"acss_debit": {
"anyOf": [
{
"properties": {
"mandate_options": {
"properties": {
"transaction_type": {
"enum": [
"business",
"personal"
],
"type": "string"
}
},
"title": "mandate_options_param",
"type": "object"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"x-stripeBypassValidation": true
}
},
"title": "invoice_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"bancontact": {
"anyOf": [
{
"properties": {
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string"
}
},
"title": "invoice_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"card": {
"anyOf": [
{
"properties": {
"mandate_options": {
"properties": {
"amount": {
"type": "integer"
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string"
},
"description": {
"maxLength": 200,
"type": "string"
}
},
"title": "mandate_options_param",
"type": "object"
},
"network": {
"enum": [
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"interac",
"jcb",
"mastercard",
"unionpay",
"unknown",
"visa"
],
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
"request_three_d_secure": {
"enum": [
"any",
"automatic"
],
"type": "string"
}
},
"title": "subscription_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"customer_balance": {
"anyOf": [
{
"properties": {
"bank_transfer": {
"properties": {
"eu_bank_transfer": {
"properties": {
"country": {
"maxLength": 5000,
"type": "string"
}
},
"required": [
"country"
],
"title": "eu_bank_transfer_param",
"type": "object"
},
"type": {
"type": "string"
}
},
"title": "bank_transfer_param",
"type": "object"
},
"funding_type": {
"type": "string"
}
},
"title": "invoice_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"konbini": {
"anyOf": [
{
"properties": {},
"title": "invoice_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"us_bank_account": {
"anyOf": [
{
"properties": {
"financial_connections": {
"properties": {
"permissions": {
"items": {
"enum": [
"balances",
"ownership",
"payment_method",
"transactions"
],
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
"type": "array"
},
"prefetch": {
"items": {
"enum": [
"balances",
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"type": "array"
}
},
"title": "invoice_linked_account_options_param",
"type": "object"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"x-stripeBypassValidation": true
}
},
"title": "invoice_payment_method_options_param",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
]
}
},
"title": "payment_method_options",
"type": "object"
},
"payment_method_types": {
"anyOf": [
{
"items": {
"enum": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"au_becs_debit",
"bacs_debit",
"bancontact",
"boleto",
"card",
"cashapp",
"customer_balance",
"fpx",
"giropay",
"grabpay",
"ideal",
"konbini",
"link",
"paynow",
"paypal",
"promptpay",
"sepa_debit",
"sofort",
"us_bank_account",
"wechat_pay"
],
"type": "string",
"x-stripeBypassValidation": true
},
"type": "array"
},
{
"enum": [
""
],
"type": "string"
}
]
},
"save_default_payment_method": {
"enum": [
"off",
"on_subscription"
],
"type": "string"
}
},
"title": "payment_settings",
"type": "object"
},
"pending_invoice_item_interval": {
"anyOf": [
{
"properties": {
"interval": {
"enum": [
"day",
"month",
"week",
"year"
],
"type": "string"
},
"interval_count": {
"type": "integer"
}
},
"required": [
"interval"
],
"title": "pending_invoice_item_interval_params",
"type": "object"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
},
"promotion_code": {
"description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.",
"maxLength": 5000,
"type": "string"
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.",
"enum": [
"always_invoice",
"create_prorations",
"none"
],
"type": "string"
},
"transfer_data": {
"description": "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.",
"properties": {
"amount_percent": {
"type": "number"
},
"destination": {
"type": "string"
}
},
"required": [
"destination"
],
"title": "transfer_data_specs",
"type": "object"
},
"trial_end": {
"anyOf": [
{
"enum": [
"now"
],
"maxLength": 5000,
"type": "string"
},
{
"format": "unix-time",
"type": "integer"
}
],
"description": "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://stripe.com/docs/billing/subscriptions/trials) to learn more."
},
"trial_from_plan": {
"description": "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://stripe.com/docs/billing/subscriptions/trials) to learn more.",
"type": "boolean"
},
"trial_period_days": {
"description": "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://stripe.com/docs/billing/subscriptions/trials) to learn more.",
"type": "integer"
},
"trial_settings": {
"description": "Settings related to subscription trials.",
"properties": {
"end_behavior": {
"properties": {
"missing_payment_method": {
"enum": [
"cancel",
"create_invoice",
"pause"
],
"type": "string"
}
},
"required": [
"missing_payment_method"
],
"title": "end_behavior",
"type": "object"
}
},
"required": [
"end_behavior"
],
"title": "trial_settings_config",
"type": "object"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/stripe-post-customers-customer-subscriptions-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.