Custom properties
Create custom property
Custom properties
Create custom property
Create a new custom property.
POST
/
v1
/
custom-properties
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
name
string
requiredtype
enum<string>
requiredAvailable options:
date, boolean, number, text, select slug
string
requiredentities
enum<string>[]
requiredAvailable options:
customer, product, plan, quote, subscription api_only
boolean | null
default: falseauthorized_values
string[] | null
Response
201 - application/json
id
string
requiredCustom property ID.
name
string
requiredCustom property name.
slug
string
requiredCustom property unique slug.
type
enum<string>
requiredCustom property type.
Available options:
date, boolean, number, text, select entities
enum<string>[]
requiredEntities on which the custom property is available.
Available options:
customer, product, plan, quote, subscription authorized_values
string[] | null
requiredIf the custom property is of type select this is the list of available values.
api_only
boolean
default: falserequiredIf true the custom property will not be displayed in the interface.
created_at
string
requiredCreation date of the custom property.
updated_at
string
requiredUpdate date of the custom property.
Was this page helpful?