Get a purchase by reference

Retrieves a single purchase including plan snapshot, usage, and billing details.

GET /v1/sdk/purchases/{purchaseRef}

Get a purchase by reference

cURL

curl --request GET \
  --url https://api.example.com/v1/sdk/purchases/{purchaseRef}

200

{
  "amount": 9900,
  "createdAt": "<string>",
  "currency": "GBP",
  "customerEmail": "[e-mail]",
  "customerRef": "cus_3C4D5E6F",
  "isRecurring": true,
  "productRef": "prd_1A2B3C4D",
  "reference": "pur_1A2B3C4D",
  "startDate": "<string>",
  "status": "active",
  "autoRenew": true,
  "cancellationReason": "<string>",
  "cancelledAt": "<string>",
  "endDate": "<string>",
  "exchangeRate": 1.3082,
  "metadata": {},
  "nextBillingDate": "<string>",
  "originalAmount": 10000,
  "paidAt": "<string>",
  "planSnapshot": {
    "currency": "USD",
    "planType": "recurring",
    "price": 2999,
    "billingCycle": "monthly",
    "creditsPerUnit": 1,
    "features": {},
    "freeUnits": 100,
    "limit": 5000,
    "limits": {},
    "meterRef": "mtr_1A2B3C4D",
    "name": "Pro Monthly",
    "reference": "pln_1A2B3C4D"
  },
  "productName": "API Gateway Manager",
  "usage": {
    "overageCost": 0,
    "overageUnits": 0,
    "used": 150,
    "periodEnd": "2025-11-01T00:00:00Z",
    "periodStart": "2025-10-01T00:00:00Z"
  }
}

Path Parameters

purchaseRef · string · required

Purchase reference or ID

Example:

"pur_1A2B3C4D"

Response

200

application/json

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:

"[e-mail]"

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)

Show child attributes

productName · string

Product name

Example:

"API Gateway Manager"

usage · object

Usage billing state for usage-based plans

Show child attributes