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": "9d0730d3-39e4-454a-bad8-06471e6cb878",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "9866e448-3137-4a5d-9845-76c0904f11e5",
      "initial_order": "9af24766-9b1e-4eaf-be81-ca5ed6f201b0",
      "license": null,
      "price": "1ba6d9bb-d6ff-48b9-8b95-300928e94152",
      "product": "be1bd838-b39b-4cb9-ab65-cf3bc342faed",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1776176561,
      "updated_at": 1776176561
    },
    {
      "id": "ccd7b961-36a8-4356-ade0-1490a77697dd",
      "object": "purchase",
      "live_mode": true,
      "quantity": 1,
      "revoked": false,
      "revoked_at": null,
      "revoke_at": null,
      "customer": "9866e448-3137-4a5d-9845-76c0904f11e5",
      "initial_order": null,
      "license": null,
      "price": "1ba6d9bb-d6ff-48b9-8b95-300928e94152",
      "product": "be1bd838-b39b-4cb9-ab65-cf3bc342faed",
      "subscription": null,
      "variant": null,
      "review": null,
      "created_at": 1776176561,
      "updated_at": 1776176561
    }
  ]
}

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.