v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

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}

Path parameters

plan_idstring required

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring
namestring
descriptionstring
cyclestring
{"stackTrail":"paths:/v1/subscription-plan/{plan_id}:get:responses:200:content:application/json:schema:properties:cycle_repeat","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/subscription-plan/{plan_id}:get:responses:200:content:application/json:schema:properties:cycle_frequency","oasType":"schema","type":"unknown"}
currencystring
amountnumber
referencestring
created_atstring
updated_atstring

Example response

{
  "id": "973ee344-6737-4897-9929-edbc9d7bf433",
  "name": "Spotify Premium",
  "description": "Spotify Monthly Subscription",
  "cycle": "monthly",
  "currency": "sgd",
  "amount": 9.9,
  "reference": "spotify_premium_2022",
  "created_at": "2022-09-12T14:22:26",
  "updated_at": "2022-09-12T14:22:26"
}