Skip to main content
​
id
string

The service's unique identifier.

Example:

"ser_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
category_id
string

The service category identifier.

Example:

"cat_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
appointment_notification_set_id
string | null

The appointment notification set identifier.

Example:

"ans_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
tax_id
string

The tax identifier.

Example:

"tax_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
name
string

The service's name.

Example:

"Initial Consultation"

​
description
string | null

The service's description.

Example:

"Comprehensive initial assessment and treatment planning session."

​
item_code
string | null

The service's item code.

Example:

"IC001"

​
duration
integer

The service duration in minutes.

Example:

60

​
buffer_before_duration
integer

The buffer time before the service in minutes.

Example:

5

​
buffer_after_duration
integer

The buffer time after the service in minutes.

Example:

10

​
price
number

The service price.

Example:

150

​
price_unit
enum<string>

The service price unit.

Available options:
hourly,
fixed
Example:

"hourly"

​
price_per_client
boolean

Whether the price is per client (true) or per appointment (false).

Example:

false

​
online_appointment_booking
boolean

Whether online appointment booking is enabled for this service.

Example:

true

​
online_payment
boolean

Whether online payment is enabled for this service.

Example:

false

​
online_payment_basis
enum<string> | null

The online payment basis (percentage or fixed).

Available options:
fixed,
percentage
Example:

"percentage"

​
online_payment_amount
integer

The online payment amount (percentage 0-100 or fixed amount in cents).

Example:

100

​
online_payment_required
boolean

Whether online payment is required or optional.

Example:

true

​
online_payment_amount_formatted
string | null

The formatted online payment amount for display.

Example:

"100%"

​
travel
boolean

Whether billable travel time applies to this service.

Example:

false

​
travel_name
string | null

The travel name.

Example:

"Travel"

​
travel_item_code
string | null

The travel item code.

Example:

"TRV001"

​
travel_price
integer | null

The travel price.

Example:

5000

​
travel_before_duration
integer | null

The billable travel time before the appointment in minutes.

Example:

15

​
travel_after_duration
integer | null

The billable travel time after the appointment in minutes.

Example:

15

​
travel_tax_id
string | null

The travel tax identifier.

Example:

"tax_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
travel_expenses
boolean

Whether travel expenses apply to this service.

Example:

false

​
travel_expenses_name
string | null

The travel expenses name.

Example:

"Mileage"

​
travel_expenses_item_code
string | null

The travel expenses item code.

Example:

"TRVEXP001"

​
travel_expenses_price
integer | null

The travel expenses price per unit.

Example:

99

​
travel_expenses_price_unit
enum<string> | null

The travel expenses price unit (km, mile or each).

Available options:
km,
mile,
each
Example:

"km"

​
travel_expenses_quantity
string | null

The travel expenses quantity.

Example:

"12.50"

​
travel_expenses_tax_id
string | null

The travel expenses tax identifier.

Example:

"tax_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
transport
boolean

Whether transport applies to this service.

Example:

false

​
transport_name
string | null

The transport name.

Example:

"Transport"

​
transport_item_code
string | null

The transport item code.

Example:

"TRN001"

​
transport_price
integer | null

The transport price per unit.

Example:

99

​
transport_price_unit
enum<string> | null

The transport price unit (km, mile or each).

Available options:
km,
mile,
each
Example:

"km"

​
transport_quantity
string | null

The transport quantity.

Example:

"12.50"

​
transport_tax_id
string | null

The transport tax identifier.

Example:

"tax_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
practitioner_ids
string[]

The IDs of practitioners who can provide this service.

Example:
​
location_ids
string[]

The IDs of locations where this service is available.

Example:
​
tag_ids
string[]

The IDs of tags attached to this service.

Example:
​
created_at
string

The timestamp when the service was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"