The /orders endpoint retrieves information about specific order events, or all orders within specified criteria.
You can apply the following parameters to return associated orders:

  • Order ID
  • Date range
  • Product path

You can apply multiple parameters to a single request. The API will return paginated results with up to 50 records per page.

👍

To limit page results, specify a custom limit to the number of records per page. Include the desired number per page in your request.

The following request parameters are available when calling the /orders endpoint

Parameter

Values

Description

begin

yyyy-mm-dd

filters results to include transactions after the specified begin date (must be at least one day before the specified end date)

days

integer

filters results to include transactions within a certain time frame

end

yyyy-mm-dd

filters results to include transactions before the specified end date

limit

integer

integer limits the number of order records returned per page (default is 50 records)

page

integer

specifies page number of results to be returned; used together with limit to control pagination

products

string

filters results to include only transactions involving the specified product ID(s) / product path(s)

rebill

true/false

filters results to include only subscription rebill transactions or exclude all subscription rebill transactions

returns

true/false

filters results to include orders with or without returns; response includes returns array with return IDs where applicable

scope

all,live,test

filters results to include live transactions, test transactions, or both

status

completed, cancelled, failed

filters results by transaction status; "completed" = successful orders, "canceled" = declined orders, "failed" = transaction failed to complete (very uncommon)