Orders and refunds

Read a UCP checkout

Read current checkout state, including an in-flight completion. Poll here instead of submitting payment again. The UCP profile at /.well-known/ucp links the full shopping contract.

get/ucp/v1/checkout-sessions/{id}

Request

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

Path parameters

idstring required

The checkout id returned when creating the session.

Response

Current checkout.

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.