Skip to main content
POST

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Body

application/json
user_id
integer
required

Owner user id.

service_type
enum<string>
required

product creates a service from a catalog product, custom creates a standalone service.

Available options:
product,
custom
product_id
integer

Required when service_type is product.

billing_cycle
string

Required for custom. For product, defaults to the first enabled cycle.

Maximum string length: 100
service_name
string

Required for custom.

Maximum string length: 255
price
number

Required for custom. Recurring price.

Required range: x >= 0
category_id
integer

Required for custom.

custom_fields
object

Custom only. Extra fields shown on the service page.

custom_buttons
object[]

Custom only. Buttons shown on the service page.

due_date
string<date>

First due date, must be after today.

notes
string | null

Internal note, up to 5000 characters.

Maximum string length: 5000

Response

Created.

data
object
required
meta
object
required
message
string

Human readable confirmation.