List subscriptions

get

https://api-sandbox.ezypay.com/v2/billing/subscriptions

Get a list of subscriptions for a specific merchant by customer, status and/or null payment methods. The subscriptions are returned sorted by creation date, with the most recently created subscription appearing first.

By default only 10 record will be listed, if the limit is not set when the API is being triggered.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

string

Auto-generated UUID identifier of the customer.

status

string

Defaults to ACTIVE

Filter subscriptions by status. Accepted values are ACTIVE, FUTURE, PENDING, PAST_DUE, PENDING_CANCELLATION, CANCELLED and COMPLETED.

filterNullPaymentMethods

boolean

Defaults to false

Filter for only subscriptions that have null payment methods. Default value is false.

limit

int32

Defaults to 100

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursor

int32

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers

merchant

string

required

Merchant ID

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Choose an example:

application/json

text/plain

200200

400400