API documentation
Integrations
Analytics
Billable events
Companies
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoicing entities
Organisations
Payments
Price configurations
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
Get products
Retrieve all existing 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",
"type": "flat_fee",
"name": "Product name",
"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": {},
"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
0 < x < 100
x > 0
Response
List of Product.
Product ID.
flat_fee
Product name.
Product description.
Indicates if the dates of the interval should be automatically added in the product description on the invoices.
Public description of the product.
Product name and description translations.
Key/value pairs to store any information you find useful.
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.
Mapping invoicing entity ID/accounting settings.
Custom tax rate ID.
Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.
Code used to assign related invoices line items to a General Ledger account in your external accounting tool.
Enable the product to be billed at any time as a one-time payment.
Enable the product to be added as part of a subscription.
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",
"type": "flat_fee",
"name": "Product name",
"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": {},
"is_available_on_demand": true,
"is_available_on_subscription": true
}
]
}