Skip to content

Commit fe9e1ce

Browse files
Update OpenAPI specification
1 parent bb72f8f commit fe9e1ce

6 files changed

+88
-84
lines changed

openapi/spec3.beta.sdk.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -175474,7 +175474,7 @@
175474175474
"description": "The account on behalf of which to charge, for each of the subscription's invoices."
175475175475
},
175476175476
"payment_behavior": {
175477-
"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.",
175477+
"description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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 PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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 PaymentIntent 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 can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't 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.",
175478175478
"enum": [
175479175479
"allow_incomplete",
175480175480
"default_incomplete",

openapi/spec3.beta.sdk.yaml

+21-20
Original file line numberDiff line numberDiff line change
@@ -166044,48 +166044,49 @@ paths:
166044166044
`collection_method=charge_automatically`.
166045166045

166046166046

166047-
Use `allow_incomplete` to create subscriptions with
166048-
`status=incomplete` if the first invoice cannot be paid.
166049-
Creating subscriptions with this status allows you to manage
166050-
scenarios where additional user actions are needed to pay a
166051-
subscription's invoice. For example, SCA regulation may
166052-
require 3DS authentication to complete payment. See the [SCA
166053-
Migration
166047+
Use `allow_incomplete` to create Subscriptions with
166048+
`status=incomplete` if the first invoice can't be paid.
166049+
Creating Subscriptions with this status allows you to manage
166050+
scenarios where additional customer actions are needed to
166051+
pay a subscription's invoice. For example, SCA regulation
166052+
may require 3DS authentication to complete payment. See the
166053+
[SCA Migration
166054166054
Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication)
166055166055
for Billing to learn more. This is the default behavior.
166056166056

166057166057

166058166058
Use `default_incomplete` to create Subscriptions with
166059166059
`status=incomplete` when the first invoice requires payment,
166060166060
otherwise start as active. Subscriptions transition to
166061-
`status=active` when successfully confirming the payment
166062-
intent on the first invoice. This allows simpler management
166063-
of scenarios where additional user actions are needed to pay
166064-
a subscription’s invoice. Such as failed payments, [SCA
166061+
`status=active` when successfully confirming the
166062+
PaymentIntent on the first invoice. This allows simpler
166063+
management of scenarios where additional customer actions
166064+
are needed to pay a subscription’s invoice, such as failed
166065+
payments, [SCA
166065166066
regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication),
166066166067
or collecting a mandate for a bank debit payment method. If
166067-
the payment intent is not confirmed within 23 hours
166068-
subscriptions transition to `status=incomplete_expired`,
166068+
the PaymentIntent is not confirmed within 23 hours
166069+
Subscriptions transition to `status=incomplete_expired`,
166069166070
which is a terminal state.
166070166071

166071166072

166072166073
Use `error_if_incomplete` if you want Stripe to return an
166073-
HTTP 402 status code if a subscription's first invoice
166074-
cannot be paid. For example, if a payment method requires
166075-
3DS authentication due to SCA regulation and further user
166076-
action is needed, this parameter does not create a
166077-
subscription and returns an error instead. This was the
166074+
HTTP 402 status code if a subscription's first invoice can't
166075+
be paid. For example, if a payment method requires 3DS
166076+
authentication due to SCA regulation and further customer
166077+
action is needed, this parameter doesn't create a
166078+
Subscription and returns an error instead. This was the
166078166079
default behavior for API versions prior to 2019-03-14. See
166079166080
the [changelog](https://stripe.com/docs/upgrades#2019-03-14)
166080166081
to learn more.
166081166082

166082166083

166083166084
`pending_if_incomplete` is only used with updates and cannot
166084-
be passed when creating a subscription.
166085+
be passed when creating a Subscription.
166085166086

166086166087

166087166088
Subscriptions with `collection_method=send_invoice` are
166088-
automatically activated regardless of the first invoice
166089+
automatically activated regardless of the first Invoice
166089166090
status.
166090166091
enum:
166091166092
- allow_incomplete

openapi/spec3.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -71640,7 +71640,7 @@
7164071640
"type": "boolean"
7164171641
},
7164271642
"payment_behavior": {
71643-
"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.",
71643+
"description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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 PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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 PaymentIntent 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 can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't 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.",
7164471644
"enum": [
7164571645
"allow_incomplete",
7164671646
"default_incomplete",
@@ -126593,7 +126593,7 @@
126593126593
"description": "The account on behalf of which to charge, for each of the subscription's invoices."
126594126594
},
126595126595
"payment_behavior": {
126596-
"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.",
126596+
"description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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 PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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 PaymentIntent 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 can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't 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.",
126597126597
"enum": [
126598126598
"allow_incomplete",
126599126599
"default_incomplete",

0 commit comments

Comments
 (0)