Skip to main content
PUT
Configure a customer's agent billing policy

Authorizations

Authorization
string
header
required

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

Path Parameters

customer_id
string
required

Query Parameters

agent
string
Required string length: 1 - 128

Body

application/json

Upsert billing policy payload

mode
enum<string>
required
Available options:
wallet,
credits,
windows
blocked
boolean
required
internal_description
string | null
Maximum string length: 1000
wallet_id
string | null
Minimum string length: 1
credit_product_id
string | null
Minimum string length: 1
markup_percent
string | null
Pattern: ^\d+(\.\d+)?$
overage_mode
enum<string> | null
Available options:
refuse,
metered
overage_markup_percent
string | null
Pattern: ^\d+(\.\d+)?$
overage_rate_card_id
string | null
Minimum string length: 1
overage_wallet_id
string | null
Minimum string length: 1
floor
string | null
Pattern: ^\d+(\.\d+)?$
settlement_interval_minutes
integer | null
Required range: 60 <= x <= 44640
settlement_schedule
enum<string> | null
Available options:
calendar_month
credit_rates
object | null
window_rates
object | null
rate_card_id
string | null
Minimum string length: 1
plan_id
string | null
Minimum string length: 1

Response

id
string
required
customer_id
string
required
internal_description
string | null
required
created_at
string<date-time>
required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

updated_at
string<date-time>
required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

agent_slug
string
required
is_default
boolean
required
mode
enum<string>
required
Available options:
wallet,
credits,
windows
wallet_id
string | null
required
credit_product_id
string | null
required
markup_percent
string
required
overage_mode
enum<string>
required
Available options:
refuse,
metered
overage_markup_percent
string
required
overage_rate_card_id
string | null
required
overage_rate_card_source
enum<string> | null
required
Available options:
policy,
plan
overage_wallet_id
string | null
required
floor
string
required
credit_rates
object | null
required
window_rates
object | null
required
rate_card_id
string | null
required
rate_card_source
enum<string> | null
required
Available options:
policy,
plan
plan
object | null
required
settlement_interval_minutes
number | null
required
settlement_schedule
enum<string> | null
required
Available options:
calendar_month
resolved_rate_card
object | null
required
blocked
boolean
required