Skip to main content
GET
/
v1
/
purchases
List
curl --request GET \
  --url https://{defaultHost}/v1/purchases \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 2,
    "limit": 20,
    "page": 1,
    "url": "/v1/purchases"
  },
  "data": [
    {
      "id": "e09486c3-2ea1-4704-ba63-3589e4f26470",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "5e9700be-ae9d-4a23-99df-144291e32a57",
      "initial_order": "b8f10120-58d4-4342-b9bb-01f3daf3dbbf",
      "license": null,
      "price": "37e3a26f-7960-4c62-a1bf-6eebe7dc8f89",
      "product": "0d2ee2eb-59fa-4fe7-aa8b-eba3144600d6",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1767909746,
      "updated_at": 1767909746
    },
    {
      "id": "a1a647d0-0045-473b-b9cd-867d02058757",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "5e9700be-ae9d-4a23-99df-144291e32a57",
      "initial_order": null,
      "license": null,
      "price": "37e3a26f-7960-4c62-a1bf-6eebe7dc8f89",
      "product": "0d2ee2eb-59fa-4fe7-aa8b-eba3144600d6",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1767909746,
      "updated_at": 1767909746
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

​
created_at
object

Only return records that were created during the given date interval.

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
downloadable
boolean

Only return objects that have associated downloads.

​
ids[]
string[]

Only return objects with the given IDs.

​
license_ids[]
string[]

Only return objects that belong to the given licenses.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
order_ids[]
string[]

Only return objects that belong to the given orders.

​
page
integer

The page of items you want returned.

​
product_ids[]
string[]

Only return objects that belong to the given products.

​
revoked
boolean

Only return objects that are revoked or not revoked.

​
subscription_ids[]
string[]

Only return objects that belong to the given subscriptions.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.