Skip to main content
POST
Create an agent billing plan

Authorizations

Authorization
string
header
required

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

Body

application/json

Create plan payload

name
string
required
Required string length: 1 - 120
mode
enum<string>
required
Available options:
wallet,
credits,
windows
rate_card_id
string | null
Minimum string length: 1
overage_mode
enum<string> | null
Available options:
refuse,
metered
markup_percent
string | null
Pattern: ^\d+(\.\d+)?$
overage_markup_percent
string | null
Pattern: ^\d+(\.\d+)?$
overage_rate_card_id
string | null
Minimum string length: 1
windows
object[]
Required array length: 1 - 8 elements
per_seat_credits
string | null
Pattern: ^\d+(\.\d+)?$
grant_rollover_enabled
boolean
settlement_interval_minutes
integer | null
Required range: 60 <= x <= 44640
settlement_schedule
enum<string> | null
Available options:
calendar_month

Response

201 - application/json
id
string
required
name
string
required
mode
enum<string>
required
Available options:
wallet,
credits,
windows
rate_card
object | null
required
windows
object[]
required
markup_percent
string | null
required
overage_mode
enum<string>
required
Available options:
refuse,
metered
overage_markup_percent
string | null
required
overage_rate_card_id
string | null
required
settlement_interval_minutes
number | null
required
settlement_schedule
enum<string> | null
required
Available options:
calendar_month
per_seat_credits
string | null
required
grant_rollover_enabled
boolean
required
billing_item_ids
string[]
required
price_configuration_ids
string[]
required
using_policy_count
number
required
is_default
boolean
required