API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Plans
Get plan
Retrieve the details of an existing plan.
GET
/
v1
/
plans
/
{id}
curl --request GET \
--url https://api.hyperline.co/v1/plans/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "plan_zHmjoDea4ZRmQV",
"name": "Starter",
"description": "Starter pack",
"commitment_interval": {
"period": "years",
"count": 1
},
"contract_start_strategy": "start_date",
"contract_start": "2025-01-01T00:00:00.000Z",
"contract_end_strategy": "duration",
"contract_end": "2025-12-31T23:59:59.999Z",
"contract_duration": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"products": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000,
"country": "all",
"currency": "EUR"
}
]
}
],
"custom_properties": {}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/plans/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "plan_zHmjoDea4ZRmQV",
"name": "Starter",
"description": "Starter pack",
"commitment_interval": {
"period": "years",
"count": 1
},
"contract_start_strategy": "start_date",
"contract_start": "2025-01-01T00:00:00.000Z",
"contract_end_strategy": "duration",
"contract_end": "2025-12-31T23:59:59.999Z",
"contract_duration": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"products": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"description": "Product internal description",
"description_display_interval_dates": true,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000,
"country": "all",
"currency": "EUR"
}
]
}
],
"custom_properties": {}
}
Assistant
Responses are generated using AI and may contain mistakes.