List wholesale statement rows
Platform module
GET/wholesale-statementswholesaleStatements.list
What the platform bills a partner for one month (1060): each client org at its plan's list price less the wholesale discount. Totals cover priced lines; unpriced lines are counted, never zero. Append-only. Returns a cursor page of wholesale statement rows the caller may see. The default order is `period_start` descending, newest first. Supports sparse fieldsets and the filter grammar.
- Requires the capability org.billing.manage.
- OAuth scopes: org.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of WholesaleStatement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the wholesale statement. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| period_start | string (date) | Yes | First day of the month billed. |
| currency_code | string | Yes | Currency of the partner agreement.Constraints: pattern ^[A-Z]{3}$ |
| wholesale_discount_bps | integer | Yes | Discount in basis points when the statement ran; agreements default to 3000, the 30 percent of ADR 0035.Constraints: range 0 to any |
| client_count | integer | Yes | Client orgs on the statement.Constraints: range 0 to any |
| list_total_minor | integer | null | Yes | Sum of priced list prices in minor units; null only while a statement has no priced line.Constraints: range 0 to any |
| wholesale_total_minor | integer | null | Yes | What the partner owes, in minor units; null only while a statement has no priced line.Constraints: range 0 to any |
| unpriced_count | integer | Yes | Lines whose plan is unpriced in the currency.Constraints: range 0 to any |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"period_start": "2026-10-08",
"currency_code": "USD",
"wholesale_discount_bps": 3000,
"client_count": 3,
"list_total_minor": 44700,
"wholesale_total_minor": 31290,
"unpriced_count": 0
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/wholesale-statements" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.wholesaleStatements.listAll()) {
console.log(row);
}for row in xos.wholesale_statements.list_all():
print(row)xos wholesale-statements list --all