Skip to main content
GET
/
subscriptions
/
plans
Subscription - Get Plans
curl --request GET \
  --url https://sandbox.hyperswitch.io/subscriptions/plans \
  --header 'X-Profile-Id: <x-profile-id>' \
  --header 'api-key: <api-key>'
[
  {
    "plan_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "price_id": [
      {
        "price_id": "<string>",
        "plan_id": "<string>",
        "amount": 123,
        "currency": "AED",
        "interval": "Day",
        "interval_count": 123,
        "trial_period": 123,
        "trial_period_unit": "Day"
      }
    ]
  }
]

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

​
X-Profile-Id
string
required

Profile ID for authentication

Query Parameters

​
limit
integer | null

Number of plans to retrieve

Required range: x >= 0
​
offset
integer | null

Number of plans to skip

Required range: x >= 0
​
product_id
string | null

Filter by product ID

Response

List of available subscription plans

​
plan_id
string
required
​
name
string
required
​
price_id
object[]
required
​
description
string | null