Recurring Billing
Get Subscription Plan Details
Use this API to get the subscription plan details, if you need to make any changes use the Update a Subscription Plan API
GET
/v1/subscription-plan/{plan_id}
X-BUSINESS-API-KEY*
X-Requested-With
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/{plan_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\n \"id\": \"973ee344-6737-4897-9929-edbc9d7bf433\",\n \"name\": \"Spotify Premium\",\n \"description\": \"Spotify Monthly Subscription\",\n \"cycle\": \"monthly\",\n \"cycle_repeat\": null,\n \"cycle_frequency\": null,\n \"currency\": \"sgd\",\n \"amount\": 9.9,\n \"reference\": \"spotify_premium_2022\",\n \"created_at\": \"2022-09-12T14:22:26\",\n \"updated_at\": \"2022-09-12T14:22:26\"\n}"
}
Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Path Parameters
plan_idrequired
string
Response
200 - application/json
amount
Default: "0"number
created_at
string
currency
string
cycle
string
cycle_frequency
any
cycle_repeat
any
description
string
id
string
name
string
reference
string
updated_at
string
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/subscription-plan/{plan_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"status": "200",
"example": "{\n \"id\": \"973ee344-6737-4897-9929-edbc9d7bf433\",\n \"name\": \"Spotify Premium\",\n \"description\": \"Spotify Monthly Subscription\",\n \"cycle\": \"monthly\",\n \"cycle_repeat\": null,\n \"cycle_frequency\": null,\n \"currency\": \"sgd\",\n \"amount\": 9.9,\n \"reference\": \"spotify_premium_2022\",\n \"created_at\": \"2022-09-12T14:22:26\",\n \"updated_at\": \"2022-09-12T14:22:26\"\n}"
}