Orders and refunds

Cancel an unfinished UCP checkout

POST /ucp/v1/checkout-sessions/{id}/cancel withdraws an unfinished checkout without a request body. It returns canceled; repeating cancellation returns the same state. It refuses complete_in_progress and completed with HTTP 409: money may be moving or the purchase already has an order. Read GET /ucp/v1/checkout-sessions/{id} for its current state. This is a state boundary, not a timed refund window. Paid refunds follow /rights#refund-policy; withdrawing a checkout does not reverse a payment.

post/ucp/v1/checkout-sessions/{id}/cancel

Request

  • Base URL: https://scvd.store
  • URL: https://scvd.store/ucp/v1/checkout-sessions/{id}/cancel
  • Auth: none required

Path parameters

idstring required

The checkout id returned when creating the session.

Response

Checkout canceled, including a repeated cancellation.

idstring required
status'incomplete' | 'requires_escalation' | 'ready_for_complete' | 'complete_in_progress' | 'completed' | 'canceled' required
currency'USD' required
expires_atstring date-time required

Deadline for accepting Complete, not a refund deadline.

line_itemsobject[] required
totalsobject[] required

Changes

No recorded changes to this operation across all 1 revision of this API.