POST `/billing/alerts`

Create a usage alert rule (e.g., send notification via specified channel when monthly API calls exceed 80%). Supports setting threshold percentage by resource type and multi-channel notification.

Billing Service `bearerAuth` application/json

Request Body

Schema: dto.CreateUsageAlertRequest

Field	Type	Required	Example
`name`	`string`	Yes	`API call volume alert`
`notification_channels`	`string`	Yes	`email,in_app`
`resource_type`	`string`	Yes	`api_calls`
`threshold_percent`	`integer`	Yes	`80`
`app_id`	`string`	No	`app_001`

Responses

Status	Description	Schema
201	Usage alert created successfully	`dto.UsageAlertDetailResponse`
400	Invalid request parameters	`object`
401	Unauthorized	`object`
500	Internal server error	`object`

Referenced Schemas

dto.UsageAlertDetailResponse

Field	Type	Required
`code`	`integer`	No
`data`	`dto.UsageAlertResponse`	No
`message`	`string`	No
`timestamp`	`string`	No

dto.UsageAlertResponse

Field	Type	Required	Example
`app_id`	`string`	No	`app_001`
`created_at`	`string`	No	`2026-05-01T00:00:00Z`
`id`	`string`	No	`ua_001`
`last_triggered_at`	`string`	No	`2026-05-10T08:00:00Z`
`name`	`string`	No	`API call volume alert`
`notification_channels`	`string`	No	`email,in_app`
`resource_type`	`string`	No	`api_calls`
`status`	`string`	No	`active`
`tenant_id`	`string`	No	`tnt_xyz789`
`threshold_percent`	`integer`	No	`80`
`updated_at`	`string`	No	`2026-05-05T10:00:00Z`

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

POST /billing/alerts