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": "485ad67a-2107-44fa-913e-4016307da3f2",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "4c3836c8-0d14-41d7-aa34-fa2bf8bc9433",
      "initial_order": "1c2ad886-140e-4bfb-8c74-ce15e173ecf7",
      "license": null,
      "price": "854db95a-3551-47e5-b456-037ea8565275",
      "product": "a78af460-2b3e-4a98-a13a-233644496f35",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1771429893,
      "updated_at": 1771429893
    },
    {
      "id": "e21e75f2-f565-400f-809d-84d60d36f5b4",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "4c3836c8-0d14-41d7-aa34-fa2bf8bc9433",
      "initial_order": null,
      "license": null,
      "price": "854db95a-3551-47e5-b456-037ea8565275",
      "product": "a78af460-2b3e-4a98-a13a-233644496f35",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1771429893,
      "updated_at": 1771429893
    }
  ]
}

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.