Skip to main content
POST
Create a Ratecard

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input schema for creating a new ratecard

name
string
required

Display name of the ratecard

original_name
string

Original/system name of the ratecard (usually same as name)

percent
number

Percentage applied by this ratecard (e.g., 0, 10, 15)

currency_id
integer

Associated currency ID. Defaults to the system's base currency if not specified.

linked_to_base_price
boolean

Whether the ratecard should be calculated based on base price

external_key
string

External key for integration with external systems

Response

200 - application/json

Ratecard created successfully

A ratecard defines pricing configurations for the company

id
integer

Unique identifier for the ratecard

name
string

Display name of the ratecard

original_name
string

Original/system name of the ratecard

percent
number

Percentage applied by this ratecard

company_id
integer

Company ID that owns this ratecard

system
boolean

Whether this is a system-generated ratecard

currency_id
integer | null

Associated currency ID. Defaults to the system's base currency if not specified.

linked_to_base_price
boolean

Whether the ratecard is calculated based on base price

external_key
string | null

External key for integration with external systems

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

deleted_at
string<date-time> | null

Deletion timestamp (soft delete)