Schemas

ErrorResponse

object · required

LoginRequest

email

string · email · required

password

string · minLength: 1 · required

LoginResponse

token

string · required

JWT token

object · required

AgentPublic

id

string · uuid · required

email

string · email · required

full_name

string · required

role

string · enum · required

Enum values:

admin

supervisor

agent

is_online

boolean · required

AgentRole

string · enum

Enum values:

admin

supervisor

agent

ConversationStatus

string · enum

Enum values:

open

pending

resolved

expired

ConversationWithContact

id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

open

pending

resolved

expired

last_message_at

string · date-time · required

unread_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

contact_channel

string · required

whatsapp, instagram, or email

assigned_agent_id

string · uuid

contact_name

string

contact_phone

string

AssignAgentRequest

agent_id

string · uuid

Set to null to unassign

UpdateStatusRequest

status

string · enum · required

Enum values:

open

pending

resolved

expired

MessageType

string · enum

Enum values:

text

image

document

template

audio

video

location

sticker

MessageDirection

string · enum

Enum values:

inbound

outbound

MessageStatus

string · enum

Enum values:

pending

sent

delivered

read

failed

Message

conversation_id

string · uuid · required

direction

string · enum · required

Enum values:

inbound

outbound

type

string · enum · required

Enum values:

text

image

document

template

audio

video

location

sticker

content

required

Free-form JSON. For text messages: {text: '...'}.

status

string · enum · required

Enum values:

pending

sent

delivered

read

failed

created_at

string · date-time · required

_id

string

MongoDB ObjectId hex string

external_id

string

sender_phone

string

MessageListResponse

object[] · required

has_more

boolean · required

next_cursor

string

MongoDB ObjectId hex for next page

SendMessageRequest

type

string · enum · required

Enum values:

text

image

document

template

audio

video

location

sticker

content

required

Free-form JSON. For text: {"text": "Hello"}. For image: {"url": "...", "caption": "..."}.

Contact

id

string · uuid · required

channel_source

string · required

whatsapp, instagram, or email

tags

string[] · required

JSON array of tag strings

created_at

string · date-time · required

updated_at

string · date-time · required

phone_number

string

name

string

email

string · email

UpdateContact

At least one field required.

name

string

email

string · email

tags

string[]

CreateAgent

email

string · email · required

Must contain @

password

string · minLength: 8 · required

full_name

string · minLength: 1 · required

role

string · enum

Defaults to "agent" if omitted

Enum values:

admin

supervisor

agent

UpdateAgent

At least one field required.

email

string · email

Admin only

full_name

string · minLength: 1

role

string · enum

Admin only

Enum values:

admin

supervisor

agent

password

string · minLength: 8

UpdateAgentStatusRequest

is_online

boolean · required

ConversationNote

id

string · uuid · required

conversation_id

string · uuid · required

agent_id

string · uuid · required

content

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

NoteResponse

id

string · uuid · required

conversation_id

string · uuid · required

agent_id

string · uuid · required

agent_name

string · required

content

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

CreateNote

content

string · minLength: 1 · required

UpdateNote

content

string · minLength: 1 · required

QuickReply

id

string · uuid · required

title

string · required

content

string · required

created_by

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

shortcut

string

category

string

CreateQuickReply

title

string · minLength: 1 · required

content

string · minLength: 1 · required

shortcut

string

category

string

UpdateQuickReply

title

string

content

string

shortcut

string

category

string

OverviewResponse

total_conversations

integer · required

open_conversations

integer · required

pending_conversations

integer · required

resolved_conversations

integer · required

total_contacts

integer · required

total_agents

integer · required

online_agents

integer · required

messages_today

integer · required

resolution_rate

number · double · required

Percentage (0.0 - 100.0)

DayCount

date

string · date · required

YYYY-MM-DD

count

integer · required

TrendsResponse

period

string · required

7d, 30d, or 90d

days

integer · required

object[] · required

AgentMetric

agent_id

string · required

full_name

string · required

email

string · required

is_online

boolean · required

open_conversations

integer · required

resolved_conversations

integer · required

total_conversations

integer · required

AgentMetricsResponse

object[] · required

ChannelMetric

channel

string · required

contact_count

integer · required

conversation_count

integer · required

ChannelMetricsResponse

object[] · required

HealthResponse

status

string · enum · required

Enum values:

healthy

degraded

object · required

MediaUploadResponse

media_id

string · required

mime_type

string · required

file_size

integer · required

filename

string · required

Division

id

string · uuid · required

name

string · required

description

string · required

allocation_method

string · enum · required

Enum values:

round_robin

least_load

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

DivisionWithCount

id

string · uuid · required

name

string · required

description

string · required

allocation_method

string · enum · required

Enum values:

round_robin

least_load

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

agent_count

integer

CreateDivision

name

string · minLength: 1 · required

description

string

allocation_method

string · enum

Enum values:

round_robin

least_load

Default: least_load

UpdateDivision

name

string

description

string

allocation_method

string · enum

Enum values:

round_robin

least_load

is_active

boolean

TransferConversationRequest

At least one of to_agent_id or to_division_id must be provided.

to_agent_id

string · uuid

to_division_id

string · uuid

note

string

ConversationTransfer

id

string · uuid · required

conversation_id

string · uuid · required

transferred_by

string · uuid · required

created_at

string · date-time · required

from_agent_id

string · uuid

to_agent_id

string · uuid

to_division_id

string · uuid

note

string

from_agent_name

string

to_agent_name

string

to_division_name

string

transferred_by_name

string

BulkConversationRequest

conversation_ids

string[] · minItems: 1 · maxItems: 100 · required

required

UpdateTagsRequest

tags

string[] · required

ScheduleMessageRequest

type

string · required

content

required

Free-form JSON message content

scheduled_at

string · date-time · required

Must be in the future (UTC)

ScheduledMessage

id

string · uuid · required

conversation_id

string · uuid · required

scheduled_by

string · uuid · required

msg_type

string · required

content

required

scheduled_at

string · date-time · required

status

string · enum · required

Enum values:

pending

sent

cancelled

failed

created_at

string · date-time · required

error_message

string

sent_at

string · date-time

agent_name

string

CsatSurvey

id

string · uuid · required

conversation_id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

pending

rated

created_at

string · date-time · required

agent_id

string · uuid

rating

integer · min: 1 · max: 5

comment

string

rated_at

string · date-time

agent_name

string

contact_name

string

SubmitCsatRequest

rating

integer · min: 1 · max: 5 · required

comment

string

CsatAnalyticsResponse

period

string · required

object · required

object[] · required

SlaPolicy

id

string · uuid · required

name

string · required

first_response_time_secs

integer · required

resolution_time_secs

integer · required

warning_threshold_pct

integer · required

priority

integer · required

is_active

boolean · required

is_default

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

description

string

channel

string

division_id

string · uuid

CreateSlaPolicy

name

string · minLength: 1 · required

description

string

first_response_time_secs

integer

Default: 300

resolution_time_secs

integer

Default: 3600

warning_threshold_pct

integer

Default: 80

priority

integer

Default: 0

channel

string

division_id

string · uuid

is_default

boolean

Default: false

UpdateSlaPolicy

name

string

description

string

first_response_time_secs

integer

resolution_time_secs

integer

warning_threshold_pct

integer

priority

integer

channel

string

division_id

string · uuid

is_active

boolean

is_default

boolean

SlaBreachLog

id

string · uuid · required

conversation_id

string · uuid · required

sla_policy_id

string · uuid · required

breach_type

string · enum · required

Enum values:

first_response

resolution

threshold_secs

integer · required

actual_secs

integer · required

breached_at

string · date-time · required

ConversationSlaStatus

conversation_id

string · uuid

policy_id

string · uuid

policy_name

string

frt_status

string · enum

Enum values:

warning

breached

frt_elapsed_secs

integer

frt_threshold_secs

integer

resolution_status

string · enum

Enum values:

warning

breached

resolution_elapsed_secs

integer

resolution_threshold_secs

integer

Integration

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

is_active

boolean · required

config

object · required

Channel configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

UpsertIntegration

is_active

boolean

config

object

division_id

string · uuid

IntegrationAccount

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

CreateIntegrationAccount

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string

Required for non-WhatsApp channels. Auto-derived from phone_number_id for WhatsApp.

display_name

string

is_active

boolean

Default: false

is_default

boolean

Default: false

division_id

string · uuid

config

object

UpdateIntegrationAccount

account_key

string

display_name

string

is_active

boolean

is_default

boolean

division_id

string · uuid

config

object

WaTemplate

id

string · uuid · required

waba_id

string · required

WhatsApp Business Account ID

name

string · required

language

string · required

BCP-47 language code (e.g. id, en_US)

category

string · enum · required

Enum values:

MARKETING

UTILITY

AUTHENTICATION

status

string · enum · required

Enum values:

APPROVED

PENDING

REJECTED

PAUSED

DISABLED

components

required

Meta template components array (HEADER, BODY, FOOTER, BUTTONS)

created_at

string · date-time · required

updated_at

string · date-time · required

meta_template_id

string

Template ID assigned by Meta

header_media_url

string

Public MinIO URL for the header media (IMAGE/VIDEO/DOCUMENT)

CreateWaTemplate

name

string · required

Lowercase letters, numbers, and underscores only. Max 512 chars.

components

required

Meta template components array

language

string

Default: id

category

string · enum

Enum values:

MARKETING

UTILITY

AUTHENTICATION

Default: MARKETING

integration_account_id

string · uuid

Use specific WABA account. Falls back to META_WABA_ID env var.

OutgoingWebhook

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

CreateOutgoingWebhook

name

string · minLength: 1 · required

url

string · required

Must start with http:// or https://

secret

string

events

string[]

Valid types: message.received, message.sent, message.status, conversation.created, conversation.resolved, conversation.assigned, contact.created

UpdateOutgoingWebhook

name

string

url

string

secret

string

events

string[]

is_active

boolean

WebhookDelivery

id

string · uuid · required

webhook_id

string · uuid · required

event_type

string · required

payload

required

status

string · enum · required

Enum values:

pending

success

failed

attempt

integer · required

max_attempts

integer · required

created_at

string · date-time · required

http_status

integer

response_body

string

error_message

string

next_retry_at

string · date-time

completed_at

string · date-time

Role

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

RoleWithPermissions

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Permission

id

string · uuid · required

code

string · required

Kode izin dalam format category.action, misal: campaigns.manage

name

string · required

description

string · required

category

string · required

CreateRole

name

string · minLength: 1 · required

Nama role (akan dinormalisasi ke huruf kecil). Tidak boleh sama dengan nama role sistem.

permissions

string[] · required

Daftar kode izin yang akan diberikan ke role ini

description

string

UpdateRole

name

string

Tidak dapat diubah untuk role sistem

description

string

permissions

string[]

Menggantikan seluruh daftar izin role (replace, bukan merge)

ApiKey

id

string · uuid · required

agent_id

string · uuid · required

name

string · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

key_prefix

string · required

12 karakter pertama dari plaintext key (bukan rahasia)

scopes

required

JSON array of scope strings

is_active

boolean · required

created_at

string · date-time · required

last_used_at

string · date-time

expires_at

string · date-time

revoked_at

string · date-time

ApiKeyCreateResponse

object · required

plaintext_key

string · required

Plaintext API key — hanya ditampilkan sekali saat pembuatan. Simpan dengan aman.

CreateApiKeyRequest

name

string · minLength: 1 · required

key_type

string · enum · required

Enum values:

rest

webhook_signing

expires_at

string · date-time

Tanggal kedaluwarsa opsional (UTC)

Campaign

id

string · uuid · required

name

string · required

template_id

string · uuid · required

status

string · enum · required

Enum values:

draft

scheduled

sending

completed

failed

cancelled

total_recipients

integer · required

sent_count

integer · required

delivered_count

integer · required

read_count

integer · required

failed_count

integer · required

created_by

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

scheduled_at

string · date-time

integration_account_id

string · uuid

CampaignWithTemplate

id

string · uuid · required

name

string · required

template_id

string · uuid · required

status

string · enum · required

Enum values:

draft

scheduled

sending

completed

failed

cancelled

total_recipients

integer · required

sent_count

integer · required

delivered_count

integer · required

read_count

integer · required

failed_count

integer · required

created_by

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

scheduled_at

string · date-time

integration_account_id

string · uuid

template_name

string

template_language

string

CreateCampaign

name

string · minLength: 1 · required

template_id

string · uuid · required

Template harus berstatus APPROVED

scheduled_at

string · date-time

integration_account_id

string · uuid

UpdateCampaign

Hanya campaign berstatus draft yang dapat diubah

name

string

template_id

string · uuid

scheduled_at

string · date-time

integration_account_id

string · uuid

CampaignRecipient

id

string · uuid · required

campaign_id

string · uuid · required

phone_number

string · required

variables

required

Variabel template per penerima, misal: {"1": "John", "2": "Order #123"}

status

string · enum · required

Enum values:

pending

sent

delivered

read

failed

cancelled

created_at

string · date-time · required

contact_id

string · uuid

external_id

string

error_message

string

sent_at

string · date-time

delivered_at

string · date-time

read_at

string · date-time

conversation_id

string · uuid

mongo_message_id

string

AddRecipientsPayload

Minimal satu dari contact_ids, tags, atau phone_numbers harus diisi

contact_ids

string[]

Tambahkan penerima berdasarkan ID kontak

tags

string[]

Tambahkan semua kontak dengan tag yang cocok

phone_numbers

string[]

Tambahkan penerima langsung berdasarkan nomor telepon

variables

Pemetaan variabel per nomor telepon: {"628xxx": {"1": "John", "2": "#123"}}

PaginatedResponse

array · required

total

integer · int64 · required

page

integer · int64 · required

per_page

integer · int64 · required

total_pages

integer · int64 · required

AutomationRule

id

string · uuid · required

name

string · required

description

string · required

is_active

boolean · required

trigger_type

string · enum · required

Enum values:

conversation_created

message_received_inbound

status_changed

sla_breached

object · required

Conditions for rule matching (empty = always match)

object[] · required

Tagged-union array of automation actions

object · required

priority

integer · required

rollout_percentage

integer · min: 1 · max: 100 · required

stop_on_match

boolean · required

cooldown_secs

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

snoozed_until

string · date-time

created_by

string · uuid

updated_by

string · uuid

CreateAutomationRule

name

string · minLength: 1 · required

trigger_type

string · enum · required

Enum values:

conversation_created

message_received_inbound

status_changed

sla_breached

object[] · minItems: 1 · required

description

string

is_active

boolean

Default: true

conditions

object

alert_settings

object

schedule_settings

object

priority

integer

Default: 0

rollout_percentage

integer · min: 1 · max: 100

Default: 100

stop_on_match

boolean

Default: false

cooldown_secs

integer

Default: 0

UpdateAutomationRule

name

string

description

string

is_active

boolean

trigger_type

string · enum

Enum values:

conversation_created

message_received_inbound

status_changed

sla_breached

conditions

object

object[]

alert_settings

object

schedule_settings

object

priority

integer

rollout_percentage

integer · min: 1 · max: 100

stop_on_match

boolean

cooldown_secs

integer

AutomationControl

singleton

boolean · required

is_paused

boolean · required

updated_at

string · date-time · required

pause_reason

string

paused_until

string · date-time

updated_by

string · uuid

AutomationRuleRun

id

string · uuid · required

event_id

string · uuid · required

rule_id

string · uuid · required

conversation_id

string · uuid · required

matched

boolean · required

executed

boolean · required

result

object · required

created_at

string · date-time · required

rule_name

string

AutomationEventQueueItem

id

string · uuid · required

event_type

string · required

conversation_id

string · uuid · required

payload

object · required

payload_hash

string · required

SHA-256 hex digest of the payload

source

string · required

status

string · enum · required

Enum values:

pending

processing

done

failed

attempts

integer · required

available_at

string · date-time · required

created_at

string · date-time · required

contact_id

string · uuid

processed_at

string · date-time

error

string

ChatExpirationRule

id

string · uuid · required

channel

string · enum · required

Enum values:

instagram

window_hours

integer · required

Hours before the messaging window closes (0 = never expires)

auto_resolve

boolean · required

block_text_after_window

boolean · required

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

UpsertChatExpirationRule

window_hours

integer · min: 0

Hours before window closes (0 = never expires)

auto_resolve

boolean

block_text_after_window

boolean

is_active

boolean

RegisterRequest

org_name

string · required

Name of the new organization

admin_email

string · email · required

Email for the initial admin user

admin_password

string · minLength: 6 · required

Password for the initial admin user (min 6 characters)

WorkingHours

id

string · uuid · required

day_of_week

integer · min: 0 · max: 6 · required

Day of the week (0 = Sunday, 6 = Saturday)

start_time

string · time · required

end_time

string · time · required

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

DaySchedule

day_of_week

integer · min: 0 · max: 6 · required

start_time

string · required

end_time

string · required

is_active

boolean · required

UpsertWorkingHours

object[] · required

AppSetting

key

string · required

value

string · required

updated_at

string · date-time · required

UpdateTimezone

timezone

string · required

AiAgent

id

string · uuid · required

name

string · required

system_prompt

string · required

model

string · required

temperature

number · double · required

max_tokens

integer · required

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

welcome_message

string

parent_agent_id

string · uuid

daily_token_limit

integer

max_conversation_turns

integer

CreateAiAgent

name

string · required

system_prompt

string

model

string

temperature

number · double

max_tokens

integer

welcome_message

string

parent_agent_id

string · uuid

daily_token_limit

integer

max_conversation_turns

integer

UpdateAiAgent

name

string

system_prompt

string

model

string

temperature

number · double

max_tokens

integer

welcome_message

string

is_active

boolean

parent_agent_id

string · uuid

daily_token_limit

integer

max_conversation_turns

integer

AiAgentAssignment

id

string · uuid · required

ai_agent_id

string · uuid · required

priority

integer · required

is_active

boolean · required

channel

string · enum

Enum values:

instagram

messenger

division_id

string · uuid

CreateAiAgentAssignment

channel

string · enum

Enum values:

instagram

messenger

division_id

string · uuid

priority

integer

UpdateAiAgentAssignment

channel

string · enum

Enum values:

instagram

messenger

division_id

string · uuid

priority

integer

is_active

boolean

AiHandoffRule

id

string · uuid · required

ai_agent_id

string · uuid · required

rule_type

string · enum · required

Enum values:

keyword

message_count

sentiment

explicit_request

location

topic

config

object · required

Rule-specific configuration (e.g. keywords list, threshold)

stop_ai_after_handoff

boolean · required

is_active

boolean · required

target_division_id

string · uuid

CreateAiHandoffRule

rule_type

string · enum · required

Enum values:

keyword

message_count

sentiment

explicit_request

location

topic

config

object

target_division_id

string · uuid

stop_ai_after_handoff

boolean

UpdateAiHandoffRule

rule_type

string · enum

Enum values:

keyword

message_count

sentiment

explicit_request

location

topic

config

object

target_division_id

string · uuid

stop_ai_after_handoff

boolean

is_active

boolean

AiKnowledgeSource

id

string · uuid · required

ai_agent_id

string · uuid · required

name

string · required

source_type

string · enum · required

Enum values:

text

file

website

qna

product

chunk_count

integer · required

status

string · enum · required

Enum values:

pending

processing

ready

failed

created_at

string · date-time · required

content

string

file_url

string

original_filename

string

website_url

string

status_message

string

CreateAiKnowledgeSource

name

string · required

source_type

string · enum · required

Enum values:

text

file

website

qna

product

content

string

file_url

string

original_filename

string

website_url

string

AiKnowledgeQna

id

string · uuid · required

knowledge_source_id

string · uuid · required

question

string · required

answer

string · required

CreateAiKnowledgeQna

question

string · required

answer

string · required

AiProduct

id

string · uuid · required

ai_agent_id

string · uuid · required

name

string · required

metadata

object · required

Arbitrary JSON metadata for the product

is_active

boolean · required

created_at

string · date-time · required

description

string

price

string · decimal

Product price as a decimal string

weight

string · decimal

Product weight as a decimal string

CreateAiProduct

name

string · required

description

string

price

string · decimal

weight

string · decimal

metadata

object

UpdateAiProduct

name

string

description

string

price

string · decimal

weight

string · decimal

metadata

object

is_active

boolean

AiOrchestrationRule

id

string · uuid · required

parent_agent_id

string · uuid · required

target_agent_id

string · uuid · required

condition_prompt

string · required

Prompt evaluated to decide whether to route to target agent

priority

integer · required

is_active

boolean · required

CreateAiOrchestrationRule

target_agent_id

string · uuid · required

condition_prompt

string · required

priority

integer

UpdateAiOrchestrationRule

target_agent_id

string · uuid

condition_prompt

string

priority

integer

is_active

boolean

AiEvaluation

id

string · uuid · required

conversation_id

string · uuid · required

message_id

string · required

MongoDB message ID

original_response

string · required

corrected_response

string · required

context_message_ids

string[] · required

IDs of messages used as evaluation context

evaluated_by

string · uuid · required

Agent who performed the evaluation

created_at

string · date-time · required

CreateAiEvaluation

conversation_id

string · uuid · required

message_id

string · required

original_response

string · required

corrected_response

string · required

context_message_ids

string[]

UpdateAiEvaluation

corrected_response

string

context_message_ids

string[]

AiUsageDailySummary

date

string · date · required

prompt_tokens

integer · int64 · required

completion_tokens

integer · int64 · required

total_tokens

integer · int64 · required

total_cost

string · decimal · required

Estimated cost in USD

request_count

integer · int64 · required

TestChatRequest

object[] · required

temperature

number · double

TestChatMessage

role

string · enum · required

Enum values:

user

assistant

system

content

string · required

DeleteResponse

deleted

boolean · required

Organization

id

string · uuid · required

name

string · required

slug

string · required

status

string · enum · required

Enum values:

provisioning

active

suspended

mongo_database

string · required

schema_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

limits

object

Resource limits (max_agents, max_contacts, max_messages_month)

country

string

ISO country code (e.g. ID, US)

CreateOrganization

name

string · required

slug

string · required

URL-safe identifier for the tenant

limits

object

country

string

admin_email

string · email

admin_password

string

UpdateOrganization

name

string

limits

object

status

string · enum

Enum values:

active

suspended

TenantUsage

id

string · uuid · required

org_id

string · uuid · required

agent_count

integer · required

contact_count

integer · required

messages_this_month

integer · int64 · required

active_integrations

integer · required

usage_month

string · date · required

updated_at

string · date-time · required

TenantWithUsage

Organization record enriched with current usage metrics

id

string · uuid · required

name

string · required

slug

string · required

status

string · enum · required

Enum values:

provisioning

active

suspended

mongo_database

string · required

schema_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

limits

object

Resource limits (max_agents, max_contacts, max_messages_month)

country

string

ISO country code (e.g. ID, US)

object

SystemHealth

status

string · enum · required

Enum values:

degraded

object · required

BillingPlan

id

string · uuid · required

name

string · required

slug

string · required

currency

string · required

base_price_monthly

integer · int64 · required

base_price_annual

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

Plan resource limits (max_agents, max_contacts, max_messages_month, max_channels, max_ai_agents)

features

object · required

Feature flags (ai_agent, api_access, dedicated_support)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

CreateBillingPlan

name

string · required

slug

string · required

base_price_monthly

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

features

object · required

currency

string

Default: IDR

base_price_annual

integer · int64

sort_order

integer

UpdateBillingPlan

name

string

slug

string

currency

string

base_price_monthly

integer · int64

base_price_annual

integer · int64

per_agent_price

integer · int64

overage_message_price

integer · int64

limits

object

features

object

is_active

boolean

sort_order

integer

BillingCoupon

id

string · uuid · required

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string · required

current_uses

integer · required

valid_from

string · date-time · required

is_active

boolean · required

created_at

string · date-time · required

max_uses

integer

valid_until

string · date-time

applicable_plans

string[]

CreateBillingCoupon

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string

Default: IDR

max_uses

integer

valid_from

string · date-time

valid_until

string · date-time

applicable_plans

string[]

BillingAddon

id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

price_annual

integer · int64 · required

unit

string · required

Pricing unit (e.g. flat, per agent)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

description

string

CreateBillingAddon

name

string · required

slug

string · required

price_monthly

integer · int64 · required

description

string

price_annual

integer · int64

unit

string

Default: flat

sort_order

integer

UpdateBillingAddon

name

string

description

string

price_monthly

integer · int64

price_annual

integer · int64

is_active

boolean

sort_order

integer

Subscription

id

string · uuid · required

org_id

string · uuid · required

plan_id

string · uuid · required

status

string · enum · required

Enum values:

trial

active

past_due

cancelled

suspended

billing_period

string · enum · required

Enum values:

monthly

annual

cancel_at_period_end

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

trial_ends_at

string · date-time

current_period_start

string · date-time

current_period_end

string · date-time

payment_gateway

string

gateway_customer_id

string

gateway_subscription_id

string

CurrentPlan

Current subscription with embedded plan details

id

string · uuid · required

org_id

string · uuid · required

plan_id

string · uuid · required

status

string · enum · required

Enum values:

trial

active

past_due

cancelled

suspended

billing_period

string · enum · required

Enum values:

monthly

annual

cancel_at_period_end

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

plan_name

string · required

limits

object · required

features

object · required

trial_ends_at

string · date-time

current_period_start

string · date-time

current_period_end

string · date-time

payment_gateway

string

gateway_customer_id

string

gateway_subscription_id

string

BillingInvoice

id

string · uuid · required

org_id

string · uuid · required

invoice_number

string · required

currency

string · required

subtotal

integer · int64 · required

tax

integer · int64 · required

total

integer · int64 · required

status

string · enum · required

Enum values:

open

paid

past_due

void

refunded

partially_refunded

object[] · required

retry_count

integer · required

created_at

string · date-time · required

subscription_id

string · uuid

pdf_url

string

gateway_invoice_id

string

payment_url

string

last_retry_at

string · date-time

paid_at

string · date-time

due_date

string · date

BillingUsage

org_id

string · uuid · required

agent_count

integer · required

contact_count

integer · required

messages_this_month

integer · int64 · required

active_integrations

integer · required

usage_month

string · date · required

limits

object · required

Plan limits for comparison

PaymentMethod

id

string · uuid · required

org_id

string · uuid · required

gateway

string · required

gateway_payment_method_id

string · required

type

string · required

Payment method type (e.g. credit_card, e_wallet, virtual_account, bank_transfer)

label

string · required

is_default

boolean · required

created_at

string · date-time · required

AddPaymentMethod

gateway

string · required

gateway_payment_method_id

string · required

type

string · required

Payment method type (e.g. credit_card, e_wallet, virtual_account)

label

string · required

is_default

boolean

SubscriptionAddon

id

string · uuid · required

subscription_id

string · uuid · required

addon_id

string · uuid · required

quantity

integer · required

created_at

string · date-time · required

SubscriptionAddonDetail

id

string · uuid · required

addon_id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

quantity

integer · required

created_at

string · date-time · required

MrrSummary

total_mrr

integer · int64 · required

Total monthly recurring revenue

active_subscriptions

integer · int64 · required

trial_subscriptions

integer · int64 · required

past_due_subscriptions

integer · int64 · required

currency

string · required

RevenueByPlan

plan_id

string · uuid · required

plan_name

string · required

subscriber_count

integer · int64 · required

monthly_revenue

integer · int64 · required

currency

string · required

MonthlyRevenue

month

string · date · required

total_revenue

integer · int64 · required

invoice_count

integer · int64 · required

paid_count

integer · int64 · required

ChurnMetrics

cancelled_this_month

integer · int64 · required

suspended_this_month

integer · int64 · required

new_subscriptions_this_month

integer · int64 · required

active_at_start_of_month

integer · int64 · required

BillingAnalyticsDashboard

object · required

object[] · required

object · required