Skip to main content
GET
/
purchases
Get Purchases
curl --request GET \
  --url https://api.example.com/purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>'
{
  "has_more": true,
  "purchases": [
    {
      "purchase_id": "<string>",
      "date": "<string>",
      "total": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.subtotal.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A connection-specific token with access scope

Headers

​
x-api-key
string
required

The client's API key secret value

Query Parameters

​
limit
integer
default:10

The maximum number of purchases to return

Required range: 1 <= x <= 50
Example:

10

​
starting_after
string

The purchase id of the last purchase you processed. The next purchase returned will be the next oldest purchase.

Example:

"01J51S0JYV6N7K1030CV1ZJH30"

Response

Successful Response

​
has_more
boolean
required

Whether there are more purchases available to fetch

Example:

true

​
purchases
PurchaseSummary · object[]
required

The list of purchases for the connection sorted in descending order by purchase date

Example:
[
  {
    "date": "2024-01-01T00:00:00Z",
    "purchase_id": "01J51S0JYV6N7K1030CV1ZKSJH",
    "total": "9.34"
  }
]