Custom properties
Get custom properties
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
Custom properties
Get custom properties
Retrieve all custom properties previously created.
GET
/
v1
/
custom-properties
curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"api_only": false,
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
List of CustomProperty.
Custom property ID.
Custom property name.
Custom property unique slug.
Custom property type.
Available options:
date, boolean, number, text, select Entities on which the custom property is available.
Available options:
customer, product, plan, quote, subscription If the custom property is of type select this is the list of available values.
Creation date of the custom property.
Update date of the custom property.
If true the custom property will not be displayed in the interface.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"api_only": false,
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z"
}
]
}