Custom properties
Create custom property
API documentation
Integrations
Analytics
Billable events
Companies
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
Custom properties
Create custom property
Create a new custom property.
POST
/
v1
/
custom-properties
curl --request POST \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": "date",
"slug": "<string>",
"entities": [
"customer"
],
"api_only": false,
"authorized_values": [
"<string>"
]
}'
{
"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.
Body
application/json
Response
201 - application/json
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": "date",
"slug": "<string>",
"entities": [
"customer"
],
"api_only": false,
"authorized_values": [
"<string>"
]
}'
{
"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"
}