Skip to main content
GET
Get purchase

Authorizations

Authorization
string
header
required

Create an API key in the console. Required when accounts are enabled.

Path Parameters

purchase_id
string
required

Response

Successful Response

id
string
required
status
string
required
origin
enum<string>
required
Available options:
manual,
automatic
amount_usd
string
required
tax_usd
string | null
required

The tax added on top of the credit when it was paid; null until the payment is seen, and for payments made before tax was charged.

reversed_usd
string
required
checkout_url
string | null
required

The hosted checkout page, for the console's session. Null to an API key, which may not complete a payment.

receipt_url
string | null
required

The payment's invoice once it is paid, or its Stripe receipt, for the console's session. Null to an API key, since an invoice shows the billing address and VAT number.

created_at
number
required
credited_at
number | null
required
expires_at
number | null
required

When the purchase's credit expires; null if it never does.

expired_usd
string | null
required

What expired of it, once its expiry has been recorded; null until then.