List pass purchases
GET /customer/{id}/packages
Scope: packages:read
Query parameters: page (default 0), pageSize (default 30, max 100)
Response:
{
"data": [
{
"id": "package_456",
"type": "package",
"template": {
"id": "pass_5",
"type": "pass_template",
"name": "10-Class Pass"
},
"credits": {
"allocated": 10,
"consumed": 3
},
"created": "2025-01-15T10:00:00.000Z",
"starts": "2025-01-15T00:00:00.000Z",
"expires": "2025-07-15T00:00:00.000Z",
"is_cancelled": false,
"is_refunded": false,
"payment_details": {
"currency": "GBP",
"base100gross_price": 5000,
"base100_discount": 0,
"base100net_price": 5000
}
}
],
"total": 3,
"page": 0,
"pageSize": 30
}
Package fields
| Field | Type | Description |
|---|---|---|
id | string | Package ID (prefixed with package_) |
type | string | Always "package" |
template | object | The pass template this package was purchased from |
credits.allocated | number | Total credits on the pass |
credits.consumed | number | Total credits used |
created | string | Purchase date |
starts | string | When the pass becomes valid |
expires | string | Expiry date |
is_cancelled | boolean | Whether the pass has been voided/cancelled |
is_refunded | boolean | Whether a refund has been issued |
payment_details | object | Payment breakdown (includes currency, base100gross_price, base100_discount, base100net_price) |