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

ISO 4217 currency code of the customer-facing charge

Example:

"GBP"

customerRef
string
required

Customer reference

Example:

"cus_3C4D5E6F"

isRecurring
boolean
required

Whether the purchase is recurring

Example:

true

reference
string
required

Purchase reference

Example:

"pur_1A2B3C4D"

startDate
string
required

Start date

Example:

"2025-10-27T10:00:00Z"

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

Reason for cancellation

Example:

"Customer request"

cancelledAt
string

When purchase was cancelled

Example:

"2025-10-28T10:00:00Z"

customerEmail
string

Customer email

Example:

"customer@example.com"

endDate
string

End date of purchase

Example:

"2025-11-27T10:00:00Z"

exchangeRate
number

Exchange rate from original currency to USD

Example:

1.32

metadata
object

Arbitrary metadata attached to the purchase

nextBillingDate
string

Next billing date

origin
enum<string>

How the purchase originated

Available options:
paid,
free_default,
manual,
one_time,
credit_topup,
admin_assignment
Example:

"paid"

originalAmount
number

Original amount in the payment currency (minor units)

Example:

7500

paidAt
string

Paid at timestamp

planRef
string

Plan reference from the plan snapshot, for reliable plan matching

Example:

"pln_abc123"

planSnapshot
object

Snapshot of the plan at time of purchase

productName
string

Product name

Example:

"API Gateway Manager"

productRef
string

Product reference

Example:

"prd_abc123"

requiresPayment
boolean

Whether the purchase requires payment

Example:

false

usage
object

Billing period of the active usage window; counts come from /v1/sdk/limits