Skip to main content
GET
Get a purchase by reference

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Path Parameters

purchaseRef
string
required

Purchase reference or ID

Example:

"pur_1A2B3C4D"

Response

Purchase retrieved successfully

amount
number
required

Amount in USD cents (normalised for aggregation)

Example:

9900

createdAt
string
required

Created at

currency
string
required

Original payment currency code

Example:

"GBP"

customerEmail
string
required

Customer email

Example:

"customer@example.com"

customerRef
string
required

Customer reference

Example:

"cus_3C4D5E6F"

isRecurring
boolean
required

Is recurring

Example:

true

productRef
string
required

Product reference

Example:

"prd_1A2B3C4D"

reference
string
required

Purchase reference

Example:

"pur_1A2B3C4D"

startDate
string
required

Start date

status
string
required

Purchase status

Example:

"active"

autoRenew
boolean

Auto-renew enabled

billingCycle
enum<string>

Billing cycle

Available options:
weekly,
monthly,
quarterly,
yearly
cancellationReason
string

Cancellation reason

cancelledAt
string

Cancelled at

endDate
string

End date

exchangeRate
number

Exchange rate from original currency to USD

Example:

1.3082

metadata
object

Arbitrary metadata attached to the purchase

nextBillingDate
string

Next billing date

originalAmount
number

Original amount in the payment currency (cents/pence)

Example:

10000

paidAt
string

Paid at timestamp

planSnapshot
object

Plan snapshot at time of purchase (null for credit topups)

productName
string

Product name

Example:

"API Gateway Manager"

usage
object

Usage billing state for usage-based plans