Skip to main content
GET
Get purchases for your organization

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Query Parameters

status
enum<string>

Filter by purchase status (pending, paid, refunded, cancelled)

Available options:
pending,
paid,
refunded,
cancelled
metadata
string

Filter by metadata key:value (e.g., "refunded:true", "campaign:affiliate")

Matches metadata text, your external purchase ID (partial, case-insensitive), or the purchase ID (full UUID). At most 100 characters; matched literally (% and _ are not wildcards).

Maximum string length: 100
startDate
string

Only include purchases from this date onwards

endDate
string

Only include purchases up to this date

limit
integer
default:50

Results per page (default: 50, max: 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Skip this many results (for pagination)

Required range: x >= 0
cursor
string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

A cursor that was not returned by this endpoint, or one from a request with a different sort, is rejected with 400.

Maximum string length: 512
sort
string

Sort results. Format: field:direction where direction is asc or desc.

Allowed fields: created_at, purchase_date, price_paid, status

Default: created_at:desc

Examples: created_at:asc, current_balance:desc

Response

Success - Returns paginated list of purchases

success
boolean
Example:

true

data
object
Example: