Returns list of subscriptions

get

https://api.test.bictorys.com/billing/v1/subscriptions

This API returns the list of subscriptions for a merchant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start_date

date

Defaults to 2023-09-01

Query subscription starting from this date. The date format is (YYYY-mm-dd). If omitted, 2023-09-01 is used

end_date

date

Query subscription from start_date until this date time. The date format is YYYY-mm-dd. If end_date is omitted,
current date is used.

status

string

enum

Filter by subscription status. The status filter is combined with start_date and end_date filters.
Status opened means the subscription plan is created but no payment is done.
started means at least a payment is done but not the entire amount.

Allowed:

page_offset

integer

Defaults to 0

pagination offset, default is 0.

page_size

integer

Defaults to 20

Page size. default value is 20

Headers

X-Amzn-Trace-Id

string

HTTP request identifier allow to trace individual request sent from client to service.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

The caller is not authenticated

403

Access rights not sufficient

200returns list of subscription.

400Bad Request

500Internal Server Error.