From fcdbb2b13713427610c13addaaf3b6b75fdcf799 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 28 Feb 2024 09:49:08 +0000 Subject: [PATCH] Update OpenAPI specification --- openapi/spec3.beta.sdk.json | 28 +++++++++---------- openapi/spec3.beta.sdk.yaml | 55 +++++++++++++++++++++---------------- openapi/spec3.json | 28 +++++++++---------- openapi/spec3.sdk.json | 28 +++++++++---------- openapi/spec3.sdk.yaml | 55 +++++++++++++++++++++---------------- openapi/spec3.yaml | 55 +++++++++++++++++++++---------------- 6 files changed, 135 insertions(+), 114 deletions(-) diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index ec1d2d2a..54196652 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -6688,7 +6688,7 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { - "description": "Describes whether Checkout should collect the customer's billing address.", + "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -7008,7 +7008,7 @@ } }, "payment_method_collection": { - "description": "Configure whether a Checkout Session should collect a payment method.", + "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" @@ -7061,7 +7061,7 @@ "type": "string" }, "redirect_on_completion": { - "description": "Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -7188,7 +7188,7 @@ "nullable": true }, "ui_mode": { - "description": "The UI mode of the Session. Can be `hosted` (default) or `embedded`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -35464,7 +35464,7 @@ "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -35610,7 +35610,7 @@ "nullable": true }, "payment_method_collection": { - "description": "Configuration for collecting a payment method during checkout.", + "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" @@ -83512,7 +83512,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Specify whether Checkout should collect the customer's billing address.", + "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -84396,7 +84396,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -85207,7 +85207,7 @@ "type": "object" }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -85823,7 +85823,7 @@ "type": "object" }, "ui_mode": { - "description": "`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -142468,7 +142468,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -143024,7 +143024,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -143772,7 +143772,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -144331,7 +144331,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index b91e2fc8..521e60fd 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -6253,7 +6253,7 @@ components: billing_address_collection: description: >- Describes whether Checkout should collect the customer's billing - address. + address. Defaults to `auto`. enum: - auto - required @@ -6543,7 +6543,7 @@ components: payment_method_collection: description: >- Configure whether a Checkout Session should collect a payment - method. + method. Defaults to `always`. enum: - always - if_required @@ -6596,11 +6596,10 @@ components: type: string redirect_on_completion: description: >- - Applies to Checkout Sessions with `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a successful - confirmation. If you set `redirect_on_completion: 'if_required'`, - then we will only redirect if your user chooses a redirect-based - payment method. + This parameter applies to `ui_mode: embedded`. Learn more about the + [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -6706,7 +6705,7 @@ components: description: Tax and discount details for the computed total amount. nullable: true ui_mode: - description: The UI mode of the Session. Can be `hosted` (default) or `embedded`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -32139,7 +32138,9 @@ components: automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -32264,7 +32265,9 @@ components: during checkout. nullable: true payment_method_collection: - description: Configuration for collecting a payment method during checkout. + description: >- + Configuration for collecting a payment method during checkout. + Defaults to `always`. enum: - always - if_required @@ -75500,7 +75503,7 @@ paths: billing_address_collection: description: >- Specify whether Checkout should collect the customer's - billing address. + billing address. Defaults to `auto`. enum: - auto - required @@ -76593,7 +76596,8 @@ paths: or a discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -77945,11 +77949,10 @@ paths: type: object redirect_on_completion: description: >- - This parameter applies to `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a - successful confirmation. If you set `redirect_on_completion: - 'if_required'`, then we will only redirect if your user - chooses a redirect-based payment method. + This parameter applies to `ui_mode: embedded`. Learn more + about the [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -78641,9 +78644,7 @@ paths: title: tax_id_collection_params type: object ui_mode: - description: >- - `ui_mode` can be `hosted` or `embedded`. The default is - `hosted`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -134977,7 +134978,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -135561,7 +135564,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -136274,7 +136278,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -136775,7 +136781,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method diff --git a/openapi/spec3.json b/openapi/spec3.json index 5af10f71..7d724f5d 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -4365,7 +4365,7 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { - "description": "Describes whether Checkout should collect the customer's billing address.", + "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -4685,7 +4685,7 @@ } }, "payment_method_collection": { - "description": "Configure whether a Checkout Session should collect a payment method.", + "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" @@ -4738,7 +4738,7 @@ "type": "string" }, "redirect_on_completion": { - "description": "Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -4865,7 +4865,7 @@ "nullable": true }, "ui_mode": { - "description": "The UI mode of the Session. Can be `hosted` (default) or `embedded`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -23521,7 +23521,7 @@ "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -23667,7 +23667,7 @@ "nullable": true }, "payment_method_collection": { - "description": "Configuration for collecting a payment method during checkout.", + "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" @@ -60485,7 +60485,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Specify whether Checkout should collect the customer's billing address.", + "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -61274,7 +61274,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -61977,7 +61977,7 @@ "type": "object" }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -62549,7 +62549,7 @@ "type": "object" }, "ui_mode": { - "description": "`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -101964,7 +101964,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -102465,7 +102465,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -103186,7 +103186,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -103696,7 +103696,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json index 662f7c9f..b6d40094 100644 --- a/openapi/spec3.sdk.json +++ b/openapi/spec3.sdk.json @@ -5641,7 +5641,7 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { - "description": "Describes whether Checkout should collect the customer's billing address.", + "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -5961,7 +5961,7 @@ } }, "payment_method_collection": { - "description": "Configure whether a Checkout Session should collect a payment method.", + "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" @@ -6014,7 +6014,7 @@ "type": "string" }, "redirect_on_completion": { - "description": "Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -6141,7 +6141,7 @@ "nullable": true }, "ui_mode": { - "description": "The UI mode of the Session. Can be `hosted` (default) or `embedded`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -28987,7 +28987,7 @@ "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -29133,7 +29133,7 @@ "nullable": true }, "payment_method_collection": { - "description": "Configuration for collecting a payment method during checkout.", + "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" @@ -69023,7 +69023,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Specify whether Checkout should collect the customer's billing address.", + "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -69907,7 +69907,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -70703,7 +70703,7 @@ "type": "object" }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -71319,7 +71319,7 @@ "type": "object" }, "ui_mode": { - "description": "`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -107008,7 +107008,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -107564,7 +107564,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -108312,7 +108312,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -108871,7 +108871,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", + "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml index 58b17bbd..5e1a4430 100644 --- a/openapi/spec3.sdk.yaml +++ b/openapi/spec3.sdk.yaml @@ -5303,7 +5303,7 @@ components: billing_address_collection: description: >- Describes whether Checkout should collect the customer's billing - address. + address. Defaults to `auto`. enum: - auto - required @@ -5593,7 +5593,7 @@ components: payment_method_collection: description: >- Configure whether a Checkout Session should collect a payment - method. + method. Defaults to `always`. enum: - always - if_required @@ -5646,11 +5646,10 @@ components: type: string redirect_on_completion: description: >- - Applies to Checkout Sessions with `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a successful - confirmation. If you set `redirect_on_completion: 'if_required'`, - then we will only redirect if your user chooses a redirect-based - payment method. + This parameter applies to `ui_mode: embedded`. Learn more about the + [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -5756,7 +5755,7 @@ components: description: Tax and discount details for the computed total amount. nullable: true ui_mode: - description: The UI mode of the Session. Can be `hosted` (default) or `embedded`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -26460,7 +26459,9 @@ components: automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -26585,7 +26586,9 @@ components: during checkout. nullable: true payment_method_collection: - description: Configuration for collecting a payment method during checkout. + description: >- + Configuration for collecting a payment method during checkout. + Defaults to `always`. enum: - always - if_required @@ -62889,7 +62892,7 @@ paths: billing_address_collection: description: >- Specify whether Checkout should collect the customer's - billing address. + billing address. Defaults to `auto`. enum: - auto - required @@ -63982,7 +63985,8 @@ paths: or a discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -65312,11 +65316,10 @@ paths: type: object redirect_on_completion: description: >- - This parameter applies to `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a - successful confirmation. If you set `redirect_on_completion: - 'if_required'`, then we will only redirect if your user - chooses a redirect-based payment method. + This parameter applies to `ui_mode: embedded`. Learn more + about the [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -66008,9 +66011,7 @@ paths: title: tax_id_collection_params type: object ui_mode: - description: >- - `ui_mode` can be `hosted` or `embedded`. The default is - `hosted`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -101191,7 +101192,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -101775,7 +101778,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -102488,7 +102492,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -102989,7 +102995,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml index 7ece395f..89674b6e 100644 --- a/openapi/spec3.yaml +++ b/openapi/spec3.yaml @@ -4284,7 +4284,7 @@ components: billing_address_collection: description: >- Describes whether Checkout should collect the customer's billing - address. + address. Defaults to `auto`. enum: - auto - required @@ -4574,7 +4574,7 @@ components: payment_method_collection: description: >- Configure whether a Checkout Session should collect a payment - method. + method. Defaults to `always`. enum: - always - if_required @@ -4627,11 +4627,10 @@ components: type: string redirect_on_completion: description: >- - Applies to Checkout Sessions with `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a successful - confirmation. If you set `redirect_on_completion: 'if_required'`, - then we will only redirect if your user chooses a redirect-based - payment method. + This parameter applies to `ui_mode: embedded`. Learn more about the + [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -4737,7 +4736,7 @@ components: description: Tax and discount details for the computed total amount. nullable: true ui_mode: - description: The UI mode of the Session. Can be `hosted` (default) or `embedded`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -22155,7 +22154,9 @@ components: automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -22280,7 +22281,9 @@ components: during checkout. nullable: true payment_method_collection: - description: Configuration for collecting a payment method during checkout. + description: >- + Configuration for collecting a payment method during checkout. + Defaults to `always`. enum: - always - if_required @@ -54499,7 +54502,7 @@ paths: billing_address_collection: description: >- Specify whether Checkout should collect the customer's - billing address. + billing address. Defaults to `auto`. enum: - auto - required @@ -55186,7 +55189,8 @@ paths: or a discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -55734,11 +55738,10 @@ paths: type: object redirect_on_completion: description: >- - This parameter applies to `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a - successful confirmation. If you set `redirect_on_completion: - 'if_required'`, then we will only redirect if your user - chooses a redirect-based payment method. + This parameter applies to `ui_mode: embedded`. Learn more + about the [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -56249,9 +56252,7 @@ paths: title: tax_id_collection_params type: object ui_mode: - description: >- - `ui_mode` can be `hosted` or `embedded`. The default is - `hosted`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -87699,7 +87700,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -88067,7 +88070,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -88684,7 +88688,9 @@ paths: title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -89031,7 +89037,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method