checkouts

Get checkout

Get a checkout by ID

get/checkouts/{id}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/checkouts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

200

idstring required
urlstring required
status'active' | 'completed' | 'expired' | 'archived' required
customerIdstring nullable required
externalCustomerIdstring nullable required
successUrlstring required
cancelUrlstring nullable required
expiresAtstring date-time nullable required
metadataobject nullable required
collectAddressboolean required
collectPhoneboolean required
singleUseboolean required
allowedCurrenciesstring[] required
createdAtstring date-time required
updatedAtstring date-time required
orderIdstring nullable required

The resulting order ID once checkout has completed. Null until an order is created.

Changes

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