StripeAPI.Operations.PostSubscriptions

POST /v1/subscriptions

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

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

<p>To start subscriptions where the first invoice always begins in a <code>draft</code> status, use <a href="/docs/billing/subscriptions/subscription-schedules#managing">subscription schedules</a> instead. Schedules provide the flexibility to model more complex billing configurations that change over time.</p>

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostSubscriptionsRequestBody with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items in the specification.

Create a new PostSubscriptionsRequestBodyAddInvoiceItems' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data in the specification.

Create a new PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.

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

Create a new PostSubscriptionsRequestBodyAutomaticTax' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyBillingThresholds'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

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.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method in the specification.

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. Defaults to `charge_automatically`.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_tax_rates.anyOf in the specification.

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.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.

Create a new PostSubscriptionsRequestBodyItems' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data in the specification.

Create a new PostSubscriptionsRequestBodyItems'PriceData' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring in the specification.

Create a new PostSubscriptionsRequestBodyItems'PriceData'Recurring' with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring.properties.interval in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.tax_behavior in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_behavior in the specification.

Use `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 for Billing to learn more. This is the default behavior.

Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the 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, 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.

Use `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 to learn more.

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

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings in the specification.

Payment settings to pass to invoices created by the subscription.

Create a new PostSubscriptionsRequestBodyPaymentSettings' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'AcssDebit'OneOf1 with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'AcssDebit'OneOf1MandateOptions' with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options.properties.transaction_type in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.verification_method in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf.properties.preferred_language in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf.properties.mandate_options in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1MandateOptions' with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf.properties.mandate_options.properties.amount_type in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf.properties.request_three_d_secure in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1 with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf.properties.bank_transfer in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1BankTransfer' with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf.properties.bank_transfer.properties.eu_bank_transfer in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1BankTransfer'EuBankTransfer' with all required fields.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.konbini.anyOf in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'UsBankAccount'OneOf1 with all required fields.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.financial_connections in the specification.

Create a new PostSubscriptionsRequestBodyPaymentSettings'PaymentMethodOptions'UsBankAccount'OneOf1FinancialConnections' with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.financial_connections.properties.permissions.items in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.verification_method in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf.items in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf in the specification.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.save_default_payment_method in the specification.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

Create a new PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

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

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.

Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data in the specification.

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.

Create a new PostSubscriptionsRequestBodyTransferData' with all required fields.

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf in the specification.

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The 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 to learn more.

Represents a response of the operation postSubscriptions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostSubscriptionsResponseError is used.