- 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
Get plan
Retrieve the details of an existing plan.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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
},
"renew_automatically": true,
"trial_interval": {
"period": "months",
"count": 1
},
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"prices": [
{
"type": "fee",
"amount": 123
}
]
}
],
"custom_properties": {}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
Plan ID.
Plan name.
Plan description.
Interval used to represent the commitment period of the plan.
days
, weeks
, months
, years
Indicates if the subscription to the plan should automatically renew.
Interval used to represent the trial period of the plan.
days
, weeks
, months
, years
Product ID.
Product name. This will appear on the final invoices.
Product description. This will appear on the final invoices.
Indicates if the dates of the interval should be automatically added in the product description on the invoices.
Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.
once
Indicates if the product should be billed at the start or the end of the payment interval.
start
, end
flat_fee
Price tiers of the product. If fixed amount, only one price is available.
fee
Monetary amount in currency's smallest unit.
A list of key value with the ID or the name of the custom property as the key and the custom property value as value.
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
},
"renew_automatically": true,
"trial_interval": {
"period": "months",
"count": 1
},
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"prices": [
{
"type": "fee",
"amount": 123
}
]
}
],
"custom_properties": {}
}