Update OpenAPI specification

stripe · Feb 28, 2024 · fcdbb2b · fcdbb2b
1 parent b7fe530
commit fcdbb2b
Show file tree

Hide file tree

Showing 6 changed files with 135 additions and 114 deletions.
diff --git 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
@@ -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