List all orders

get

https://api.fastspring.com/orders

Returns a list of your orders by order ID.

Query Params

begin

date

Filters results to include transactions after the specified begin date (in YYYY-MM-DD format). Must be at least one day before the specified end date.

days

int32

Filters results to include transactions within a certain time frame.

end

date

Filters results to include transactions before the specified end date (in YYYY-MM-DD format).

limit

int32

Defaults to 50

Limits the number of order records returned per page (default is 50 records).

page

int32

Defaults to 1

Specifies the 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 path(s).

rebill

boolean

Filters results to include or exclude subscription rebill transactions.

If true, the results will include subscription rebill transactions.

If false, the results will exclude subscription rebill transactions.

returns

boolean

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

scope

string

enum

Filters results to include live transactions, test transactions, or both.

Allowed:

status

string

enum

Filters results by transaction status.

completed = successful orders

canceled = declined orders

failed = transaction failed to complete

Allowed:

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK