diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index 288f9940..2abadd36 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -7708,7 +7708,7 @@ "type": "string" }, "client_secret": { - "description": "Client secret to be used when initializing Stripe.js embedded checkout.", + "description": "The client secret of the Session. Use this with [initCustomCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.", "maxLength": 5000, "nullable": true, "type": "string" @@ -8069,7 +8069,7 @@ "type": "string" }, "return_url": { - "description": "Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.", + "description": "Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.", "maxLength": 5000, "type": "string" }, @@ -8198,12 +8198,12 @@ "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ + "custom", "embedded", "hosted" ], "nullable": true, - "type": "string", - "x-stripeBypassValidation": true + "type": "string" }, "url": { "description": "The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.", @@ -74017,7 +74017,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1", + "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v1", "x-stripeSpecFilename": "spec3.beta.sdk" }, "openapi": "3.0.0", @@ -90719,7 +90719,7 @@ "type": "string" }, "cancel_url": { - "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", + "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.", "maxLength": 5000, "type": "string" }, @@ -92572,7 +92572,7 @@ "type": "string" }, "return_url": { - "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if ui_mode is `embedded`\nand redirect-based payment methods are enabled on the session.", + "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`\nand redirect-based payment methods are enabled on the session.", "maxLength": 5000, "type": "string" }, @@ -93187,7 +93187,7 @@ "type": "object" }, "success_url": { - "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded`. If you’d like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).", + "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).", "maxLength": 5000, "type": "string" }, @@ -93208,11 +93208,11 @@ "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ + "custom", "embedded", "hosted" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" } }, "type": "object" diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 32e5bf43..dc665706 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -66818,7 +66818,7 @@ "type": "string" }, "cancel_url": { - "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", + "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`.", "maxLength": 5000, "type": "string" },