OpenAPI Update (#692)

Update OpenAPI for fcdbb2b13713427610c13addaaf3b6b75fdcf799 Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
stripe · Feb 28, 2024 · 826b936 · 826b936
1 parent 74054ee
commit 826b936
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 28 deletions.
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/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/embedded/openapi/spec3.json b/embedded/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"