Sign in

v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Purchases

List purchases

Returns a cursor-paginated list of purchases recorded in the account, typically imported from e-commerce platforms. Each purchase includes its transaction_id, status, source (e.g. the originating platform), the buyer's email_address and subscriber_id, monetary breakdown (subtotal, discount, tax, total, currency), and the purchased products.

To record a new purchase, use Create a purchase.

get/v4/purchases

Query parameters

{"stackTrail":"paths:/v4/purchases:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/purchases:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/purchases:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

Response

Returns a paginated list of all purchases for your account