Skip to main content
POST
Create an agent rate card

Authorizations

Authorization
string
header
required

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

Body

application/json

Create rate card payload

name
string
required

Human-readable resource name.

Required string length: 1 - 120
Example:

"Support agent plan"

rows
object[]
required

All pricing rows on the card; replacement replaces the complete list.

Maximum array length: 1000
Example:
denomination
enum<string>
required

Unit in which rate-card prices are expressed.

  • credits: Credit counts.
  • units: Weighted rolling-allowance units.
  • currency: Major units of the specified currency.
Available options:
credits,
units,
currency
Example:

"currency"

fallback_per_usd
string | null

Credits, allowance units, or major currency units per USD of provider cost. Null leaves unmatched usage unpriced.

Maximum string length: 40
Pattern: ^\d+(\.\d+)?$
Example:

"1"

currency
enum<string> | null

ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.

Available options:
EUR,
AED,
AFN,
XCD,
ALL,
AMD,
AOA,
ARS,
USD,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
XOF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
NOK,
BWP,
BYR,
BZD,
CAD,
CDF,
XAF,
CHF,
NZD,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
ANG,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
MAD,
ERN,
ETB,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
XPF,
NGN,
NIO,
NPR,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
YER,
ZAR,
ZMW,
ZWL
Example:

"USD"

Response

id
string
required

Unique Hyperline identifier for this resource.

Example:

"d18603dd-7285-4bf5-a45e-88d7de8f37c9"

name
string
required

Human-readable resource name.

Example:

"Support agent plan"

denomination
enum<string>
required

Unit in which rate-card prices are expressed.

  • credits: Credit counts.
  • units: Weighted rolling-allowance units.
  • currency: Major units of the specified currency.
Available options:
credits,
units,
currency
Example:

"currency"

currency
enum<string> | null
required

ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.

Available options:
EUR,
AED,
AFN,
XCD,
ALL,
AMD,
AOA,
ARS,
USD,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
XOF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
NOK,
BWP,
BYR,
BZD,
CAD,
CDF,
XAF,
CHF,
NZD,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
ANG,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
MAD,
ERN,
ETB,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
XPF,
NGN,
NIO,
NPR,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
YER,
ZAR,
ZMW,
ZWL
Example:

"USD"

fallback_per_usd
string | null
required

Credits, allowance units, or major currency units per USD of provider cost. Null leaves unmatched usage unpriced.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"1"

rows
object[]
required

All pricing rows on the card; replacement replaces the complete list.

Example:
attached_product_id
string | null
required

Credit product using this card as its default, or null.

Example:

"prd_credits"

using_policy_count
number
required

Number of customer policy scopes referencing this resource.

Example:

1

using_policies
object[]
required

Bounded sample of customer scopes using this card; using_policy_count is the complete count.

Example:
using_plan_count
number
required

Number of plans referencing this rate card.

Example:

1