Plans
Get plans
- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Subscriptions
Plans
Get plans
Retrieve all existing plans.
GET
/
v1
/
plans
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
take
number
take
number
skip
number
skip
number
curl --request GET \
--url https://api.hyperline.co/v1/plans \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "plan_zHmjoDea4ZRmQV",
"name": "Starter",
"description": "Starter pack",
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"trial_interval": {
"period": "months",
"count": 1
}
}
]
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
take
number | null
default: 50skip
number | null
default: 0Response
200 - application/json
meta
object
requiredmeta.total
number
requiredTotal of existing items.
meta.taken
number
requiredNumber of items returned.
meta.skipped
number
requiredNumber of items skipped.
data
object[]
requiredList of Plan.
data.id
string
requiredPlan ID.
data.name
string
requiredPlan name.
data.description
string | null
requiredPlan description.
data.commitment_interval
object | null
requiredInterval used to represent the commitment period of the plan.
data.commitment_interval.period
enum<string>
requiredAvailable options:
days
, weeks
, months
, years
data.commitment_interval.count
number
requireddata.renew_automatically
boolean
requiredIndicates if the subscription to the plan should automatically renew.
data.trial_interval
object | null
requiredInterval used to represent the trial period of the plan.
data.trial_interval.period
enum<string>
requiredAvailable options:
days
, weeks
, months
, years
data.trial_interval.count
number
requiredcurl --request GET \
--url https://api.hyperline.co/v1/plans \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "plan_zHmjoDea4ZRmQV",
"name": "Starter",
"description": "Starter pack",
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"trial_interval": {
"period": "months",
"count": 1
}
}
]
}