Starts a Stripe Checkout session for the chosen plan.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Starts a Stripe Checkout session in the buyer’s presentment currency.
object
Defaults to USD when omitted, so an unknown locale still checks out.
Premium purchase option: an auto-renewing monthly or yearly subscription.
Responses
Section titled “Responses”Checkout URL
A URL the client should navigate to.
object
Examplegenerated
{ "url": "example"}The request is malformed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}No valid session token
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The Bearer challenge (RFC 6750).
Subscription already active
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is too large
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is not JSON
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The media type the operation takes.
Too many requests
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”Seconds to wait. Sent when the limit knows when it lifts.
The service failed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Billing unavailable
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}