Developers
Sales transactions2

List sales transactions

GET/sales/transactions

Returns sales transactions. Each transaction aggregates the events of a single sale or subscription. A transaction's ID is derived from its first event and does not change when new events are received.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
user_id?string

Only transactions of the user with this public ID.

delivery_id?string

Only transactions of the delivery with this public ID.

gateway?string

Only transactions from the gateway with this public ID.

external_id?string

Only transactions with this external_id.

status?string

Only transactions with this sale status.

updated_after?string

Only items updated after this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sales/transactions"
{  "data": [    {      "amount": "string",      "currency": "string",      "delivery_id": "string",      "enrollment_ids": [        "string"      ],      "events_count": 0,      "external_id": "string",      "external_product_id": "string",      "first_event_at": "2019-08-24T14:15:22Z",      "gateway": "string",      "id": "string",      "last_event_at": "2019-08-24T14:15:22Z",      "object": "sales_transaction",      "status": "trial",      "subscription_external_id": "string",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Sales transactions2

Sales transactions in API v3: list sales transactions, retrieve a sales transaction.

Retrieve a sales transaction GET

Retrieves a sales transaction, which aggregates the events of a single sale or subscription. A transaction is addressed only by its own ID. IDs of later events in the same transaction return `404 Not Found`.