POST
/
v1
/
subscription-plan
Create a Subscription Plan
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/subscription-plan \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "cycle": "monthly",
  "cycle_frequency": "day",
  "cycle_repeat": 123,
  "currency": "SGD",
  "amount": 123,
  "reference": "<string>",
  "redirect_url": "<string>",
  "start_date_method": "sign_up_date",
  "fixed_date": 14.5,
  "times_to_be_charged": 1
}'
"{\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.90,\n    \"reference\": \"spotify_premium_2022\",\n    \"created_at\": \"2022-09-12T14:19:26\",\n    \"updated_at\": \"2022-09-12T14:19:26\"\n}"

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

Response

200
application/json

200

The response is of type object.