Fetch subscription plan list
GET
/v1/subscriptions/plansFetch all saved subscription plan list (multiple subscription plans). Within a single subscription plan, one product can be included (one plan, one product). There can be multiple plans for the same product. The plans can differ by some parameters such as trial period, fee charge day, activation fee, amount, currency, interval count or interval unit etc.
Request
Query Params
itemsPerPage
string
optional
Limit of results
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Page of results
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
string
optional
Direction of order
Allowed values:
ascdesc
Default:
asc
sortBy
string
optional
column sorting
Allowed values:
idmerchantIdshopIdterminalIdcreatedAtupdatedAt
Default:
createdAt
Header Params
request-id
string
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
Request samples
Responses
OK(200)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array[object (Plan) {18}]
required
id
string <uuid>
required
merchantId
string
required
shopId
string
required
terminalId
string
required
status
boolean
required
trialPeriodDays
integer
optional
>= 0
chargeDay
integer
optional
>= 1
setupFee
string
optional
amount
string
required
<= 128 characters
currency
string
required
<= 3 characters
intervalUnit
string
required
Allowed values:
dayweekmonthyear
intervalCount
integer
required
>= 1
totalCount
integer
required
chargeRetry
boolean
required
productId
string <uuid>
required
createdAt
required
updatedAt
required
deletedAt
string
optional
Match pattern:
d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?
meta
object
Meta
itemsPerPage
string
optional
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
string
optional
Allowed values:
ascdesc
Default:
asc
sortBy
string
optional
Allowed value:
createdAt
Default:
createdAt
Example
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchantId": "string",
"shopId": "string",
"terminalId": "string",
"status": true,
"trialPeriodDays": 0,
"chargeDay": 1,
"setupFee": "string",
"amount": "string",
"currency": "str",
"intervalUnit": "day",
"intervalCount": 1,
"totalCount": 0,
"chargeRetry": true,
"productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
"createdAt": "2019-08-24",
"updatedAt": "2019-08-24",
"deletedAt": "string"
}
],
"meta": {
"itemsPerPage": "10",
"page": "1",
"direction": "asc",
"sortBy": "createdAt"
}
}
Modified at 14 days ago