Recurring Billing
Get All Subscription Plan
- Getting Started
- Online Payments
- In Person Payments
- Event Webhooks
- Recurring Billing
- Save Card for Billing
- Platform APIs
Payout APIs
Payment Request
Recurring Billing
- POSTCreate a Subscription Plan
- PUTUpdate Subscription Plan
- GETGet Subscription Plan Details
- GETGet All Subscription Plan
- DELDelete Subscription Plan
- POSTCreate Recurring Billing
- PUTUpdate recurring billing
- GETGet All Recurring Billing
- DELDelete Recurring Billing
- POSTCharge the saved card
- GETGet saved card details
- POST
Charges
Payout
Account
Orders
Products
Customers
Invoice
Webhook Events
Notifications
Guides
API References
Recurring Billing
Get All Subscription Plan
Use this API to get all subscription plans details.
GET
/
v1
/
subscription-plan
/
X-BUSINESS-API-KEY
string
*
X-BUSINESS-API-KEY
Required
string
Add Example Value
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/ \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
"{\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}"
Headers
X-BUSINESS-API-KEY
string
requiredResponse
200 - application/json
data
object[]
data.id
string
data.name
string
data.description
string
data.cycle
string
data.cycle_repeat
integer
default: 0data.cycle_frequency
string
data.currency
string
data.price
number
default: 0data.amount
number
default: 0data.reference
any
data.created_at
string
data.updated_at
string
links
object
links.first
string
links.last
string
links.prev
any
links.next
any
meta
object
meta.current_page
integer
default: 0meta.from
integer
default: 0meta.last_page
integer
default: 0meta.links
object[]
meta.links.url
any
meta.links.label
string
meta.links.active
boolean
default: truemeta.path
string
meta.per_page
integer
default: 0meta.to
integer
default: 0meta.total
integer
default: 0Was this page helpful?
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/ \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
"{\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}"