Skip to main content
GET
List purchases for provider

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>

Filter by purchase status

Available options:
pending,
active,
trialing,
past_due,
cancelled,
expired,
suspended,
refunded
productRef
string

Filter by product reference

Maximum string length: 20
customerRef
string

Filter by customer reference

Maximum string length: 20
includeFree
boolean
default:true

Include free recurring purchases and free auto-enrollments (default true)

Response

200 - application/json

Purchases retrieved successfully

purchases
object[]