List

get

https://restapi.ordergroove.com/subscriptions/

Returns a list all of customer subscriptions for a merchant, or a list of subscriptions for an individual customer.

Query Params

live

array of booleans

Subscription status: active (True) or inactive (False)

live

product

string

Unique product identifier

shipping_address

string

Address ID

customer

string

Customer ID (only available in API user scope)

created

date

Subscription's created date exact match (yyyy-mm-dd)

created_start

date

Subscription's created date later or equal than parameter (yyyy-mm-dd)

created_end

string

Subscription's created date sooner or equal than parameter (yyyy-mm-dd)

updated

date

Subscription's updated date exact match (yyyy-mm-dd). On subscription creation is populated with same value as created field.

updated_start

date

Subscription's updated datetime later or equal than parameter (yyyy-mm-ddThh:mm:ss)

updated_end

date

Subscription's updated date time is sooner or equal than parameter (yyyy-mm-ddThh:mm:ss)

Responses

Language

Credentials

Header

Response

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

application/json

200200