Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenAPI Update #955

Merged
merged 1 commit into from
Aug 12, 2024
Merged

OpenAPI Update #955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions embedded/openapi/spec3.beta.sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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"
},
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion embedded/openapi/spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
Loading