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
Products
Get products
Retrieve all existing products.
GET
/
v1
/
products
curl --request GET \
--url https://api.hyperline.co/v1/products \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"status": "active",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"properties": {},
"custom_properties": {},
"accounting": {},
"type": "flat_fee",
"is_available_on_demand": true,
"is_available_on_subscription": true
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Required range:
0 <= x <= 100
Required range:
x >= 0
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/products \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"status": "active",
"description": "Product internal description",
"description_display_interval_dates": true,
"public_description": "Product public description",
"translations": {
"fr": {
"name": "<string>",
"public_description": "<string>"
},
"en": {
"name": "<string>",
"public_description": "<string>"
},
"de": {
"name": "<string>",
"public_description": "<string>"
},
"it": {
"name": "<string>",
"public_description": "<string>"
},
"nl": {
"name": "<string>",
"public_description": "<string>"
},
"es": {
"name": "<string>",
"public_description": "<string>"
},
"pt": {
"name": "<string>",
"public_description": "<string>"
},
"pl": {
"name": "<string>",
"public_description": "<string>"
}
},
"properties": {},
"custom_properties": {},
"accounting": {},
"type": "flat_fee",
"is_available_on_demand": true,
"is_available_on_subscription": true
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.