Recurring Billing
Get All Subscription Plan
Use this API to get all subscription plans details.
GET
/v1/subscription-plan/
X-BUSINESS-API-KEY*
X-Requested-With
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/ \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\n \"data\": [\n {\n \"id\": \"975b1909-38f6-44f3-a0b1-c198b7478978\",\n \"name\": \"subscription-plan_new_1664175178\",\n \"description\": \"New_Description_1664175178\",\n \"cycle\": \"custom\",\n \"cycle_repeat\": 1,\n \"cycle_frequency\": \"day\",\n \"currency\": \"sgd\",\n \"price\": 123.45,\n \"amount\": 123.45,\n \"reference\": null,\n \"created_at\": \"2022-09-26T14:52:58\",\n \"updated_at\": \"2022-09-26T14:52:58\"\n },\n {\n \"id\": \"97533e84-4f48-4625-83de-1d2b3e3ae17b\",\n \"name\": \"subscription-plan_new_1663837869\",\n \"description\": \"New_Description_1663837869\",\n \"cycle\": \"custom\",\n \"cycle_repeat\": 1,\n \"cycle_frequency\": \"day\",\n \"currency\": \"sgd\",\n \"price\": 9999999.99,\n \"amount\": 9999999.99,\n \"reference\": null,\n \"created_at\": \"2022-09-22T17:11:09\",\n \"updated_at\": \"2022-09-22T17:11:09\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"last\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan\",\n \"per_page\": 25,\n \"to\": 2,\n \"total\": 2\n }\n}"
}
Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Response
200 - application/json
data
object[]
links
object
meta
object
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/ \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\n \"data\": [\n {\n \"id\": \"975b1909-38f6-44f3-a0b1-c198b7478978\",\n \"name\": \"subscription-plan_new_1664175178\",\n \"description\": \"New_Description_1664175178\",\n \"cycle\": \"custom\",\n \"cycle_repeat\": 1,\n \"cycle_frequency\": \"day\",\n \"currency\": \"sgd\",\n \"price\": 123.45,\n \"amount\": 123.45,\n \"reference\": null,\n \"created_at\": \"2022-09-26T14:52:58\",\n \"updated_at\": \"2022-09-26T14:52:58\"\n },\n {\n \"id\": \"97533e84-4f48-4625-83de-1d2b3e3ae17b\",\n \"name\": \"subscription-plan_new_1663837869\",\n \"description\": \"New_Description_1663837869\",\n \"cycle\": \"custom\",\n \"cycle_repeat\": 1,\n \"cycle_frequency\": \"day\",\n \"currency\": \"sgd\",\n \"price\": 9999999.99,\n \"amount\": 9999999.99,\n \"reference\": null,\n \"created_at\": \"2022-09-22T17:11:09\",\n \"updated_at\": \"2022-09-22T17:11:09\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"last\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.sandbox.hit-pay.com/v1/subscription-plan\",\n \"per_page\": 25,\n \"to\": 2,\n \"total\": 2\n }\n}"
}