Skip to main content
GET
Get purchase

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Purchase ID

Response

Purchase

id
string<cuid2>
required

Unique identifier for the purchase

customerEmailAddress
string<email>
required

Email address used for the purchase

deliveryCharge
integer
required

Delivery charge in pence

deliveryAddress
Delivery Address · object
required

Address where the order should be delivered

subtotal
integer
required

Subtotal in pence

total
integer
required

Total in pence

serviceFee
integer
required

Service fee in pence

createdAt
string<date-time>
required

Timestamp when the purchase was created

updatedAt
string<date-time>
required

Timestamp when the purchase was last updated

orders
object[]
required

Orders included in the purchase

cases
object[]
required

Cases associated with the purchase

status
enum<string>
default:ACTIVE

Purchase status

Available options:
ACTIVE,
REFUNDED,
COMPLETED
invoiceId
string | null

Invoice identifier generated for the purchase

user
object

User that purchased the items

refunds
object[]

Refunds against this purchase (Stripe IDs omitted)