Endpoint catalog
Cancel a hosted checkout session
POST /api/v1/open/hosted/checkout/sessions/{sessionId}/cancel
POST /api/v1/open/hosted/checkout/sessions/{sessionId}/cancel
- operationId:
cancelHostedCheckoutSession - Stability: Not declared by the spec
- Authentication:
Authorizationheader API Key; required scopes:catalog:read - Idempotency: Not declared by the spec
Parameters
| Name | In | Required | Type |
|---|---|---|---|
sessionId | path | Yes | string |
Request body
- Required: Yes
- Schema:
#/components/schemas/HostedCheckoutCancelRequest
Responses and errors
| Status | Description | Schema |
|---|---|---|
200 | Successful response | #/components/schemas/HostedCheckoutSessionResponse |
400 | Request does not match the public contract | #/components/schemas/PublicErrorResponse |
401 | Authentication failed | #/components/schemas/PublicErrorResponse |
403 | Insufficient authorization scope | #/components/schemas/PublicErrorResponse |
404 | Public resource not found | #/components/schemas/PublicErrorResponse |
409 | Idempotency or state conflict | #/components/schemas/PublicErrorResponse |
429 | Rate limited | #/components/schemas/PublicErrorResponse |
Rate limiting
The spec declares a 429 response.
The Retry-After header is not declared by the spec.
Success response schema
{
"$ref": "#/components/schemas/HostedCheckoutSessionResponse"
}
Error response schema
{
"$ref": "#/components/schemas/PublicErrorResponse"
}
Generated from the verified public-only OpenAPI artifact; no speculative request example is provided.