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
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCancel subscription
- POSTReinstate subscription
- POSTPause subscription
- POSTActivate subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- PUTUpdate subscription
- POSTRefresh seat products
- POSTTransition subscription to next phase
Third-party apps
Wallets
Custom properties
Get custom properties
Retrieve all custom properties previously created.
GET
/
v1
/
custom-properties
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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.
If true the custom property will not be displayed in the interface.
Creation date of the custom property.
Update date of the custom property.
Was this page helpful?