Skip to main content

Get All Subscription Plans

Request parameters

FieldTypeDescription
pageIntNumber of the desired page for which data should be returned. Page numbers use zero-based numbering e.g. to get the 10th page, you need to set page=9.
pageSizeIntNumber of Plans per Page requested (E.g. 10).
createdAtLteDateTimeCreated before the provided date & time (Lte: Lower Than or Equal → <=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
createdAtGteDateTimeCreated after the provided date & time (Gte: Greater Than or Equal → >=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
updatedAtLteDateTimeUpdated before the provided date & time (Lte: Lower Than or Equal → <=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
updatedAtGteDateTimeUpdated after the provided date & time (Gte: Greater Than or Equal → >=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z
deletedStringPossible values: TRUE, FALSE.
nameStringName of the Plan.
info

Please note that if a query parameter non-existent in the list above is passed in the request it would be ignored. If the value sent on one of the query parameters is invalid it would also be ignored.

info

The request must provide the following header:

x-api-key: {merchantKey}

Request sample (using createdAtLte, createdAtGte, page & pageSize query params)

Path:

GET {Base URL}/plans/?createdAtLte=2021-03-17T18:18:53.01Z&amp;createdAtGte=2021-03-17T10:18:53.01Z&amp;page=1&amp;pageSize=3

Header:

Content-Type: application/json
Accept-Language: en-US

Response parameters

FieldTypeDescription
pageIntNumber of the page for which the data would be returned.
pageSizeIntNumber of the records to display per page.
countIntNumber of total records (Subscription Plans) returned for the made search/request.
totalPagesIntNumber of pages returned for the made search/request.
dataObjectList of all the Subscription Plans of the page requested. For the Subscription Plan output parameters specification, please refer to Get Subscription Plan API outputs section.

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US
{
"page": 1,
"pageSize": 3,
"count": 698,
"totalPages": 233,
"data": [
{
"id": "SubscriptionPlan-ae712dca-b9e1-4ae5-b320-22f8314a5cbf",
"createdAt": "2021-03-17T14:36:51.21Z",
"updatedAt": "2021-03-17T14:36:51.21Z",
"deletedAt": null,
"name": "Plan for negative testsUVUDBhIH3U",
"description": "Used for negative tests",
"recurrentAmount": 10.99,
"currencyIsoCode": "EUR",
"trialDurationPeriod": 7,
"trialDurationUnit": "day",
"billingUnit": "year",
"billingOccurrence": 1,
"billingCycles": 1,
"prepaid": false,
"merchantMetadata": null
},
{
"id": "SubscriptionPlan-dea14e00-2166-4728-a842-0c7fa646986a",
"createdAt": "2021-03-17T14:35:36.72Z",
"updatedAt": "2021-03-17T14:35:36.72Z",
"deletedAt": null,
"name": "Automated plan92Ai7OgT7e",
"description": "Automated descriptionk57q7",
"recurrentAmount": 10.00,
"currencyIsoCode": "EUR",
"trialDurationPeriod": 1,
"trialDurationUnit": "day",
"billingUnit": "month",
"billingOccurrence": 6,
"billingCycles": 5,
"prepaid": true,
"merchantMetadata": null
},
{
"id": "SubscriptionPlan-8dd358d3-8a46-48ba-9297-4c6e3237fc25",
"createdAt": "2021-03-17T14:35:30.81Z",
"updatedAt": "2021-03-17T14:35:30.81Z",
"deletedAt": null,
"name": "Plan for negative testsXZOTehp1ym",
"description": "Used for negative tests",
"recurrentAmount": 10.99,
"currencyIsoCode": "EUR",
"trialDurationPeriod": 7,
"trialDurationUnit": "day",
"billingUnit": "year",
"billingOccurrence": 1,
"billingCycles": 1,
"prepaid": false,
"merchantMetadata": null
}
]
}
info

For error handling, please refer to this section.