PricingTier

tierIdintegerrequired

slugstringrequired

namestringrequired

audiencestringrequired

Possible values: [human, agent]

statusstringrequired

Possible values: [draft, active, legacy, retired]

availableboolean

False while a listed tier cannot be bought. On mainnet, tiers 4, 5 and 13 stay draft until the relayer float for their rate class is funded; all eight tiers are active on devnet.

unavailableReasonstring

Present only when available is false.

Possible values: [CAPACITY]

periodMsinteger<int64>required

Possible values: >= 0

capRuDecimalStringrequired

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

priceUnitsDecimalStringrequired

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

paygBpsintegerrequired

priceDecimalStringrequired

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

paygPricePerRuDecimalStringrequired

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

pendingPriceDecimalString

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

pendingPaygPricePerRuDecimalString

Non-negative integer as decimal string (pricing document family).

Possible values: Value must match regular expression ^[0-9]+$

maxSendersintegerrequired

flagsstring[]required

Possible values: [agent, payg_allowed, priority_lane, dedicated_pool, sponsor_any_sender, custom]

rateClassintegerrequired

slaClassstringrequired

Possible values: [best-effort, standard, priority, dedicated]

successorTierIdinteger | nullnullablerequired

singlePaymentPurchasablebooleanrequired

notestring

PricingTier

{
  "tierId": 0,
  "slug": "string",
  "name": "string",
  "audience": "human",
  "status": "draft",
  "available": true,
  "unavailableReason": "CAPACITY",
  "periodMs": 0,
  "capRu": "string",
  "priceUnits": "string",
  "paygBps": 0,
  "price": "string",
  "paygPricePerRu": "string",
  "pendingPrice": "string",
  "pendingPaygPricePerRu": "string",
  "maxSenders": 0,
  "flags": [
    "agent"
  ],
  "rateClass": 0,
  "slaClass": "best-effort",
  "successorTierId": 0,
  "singlePaymentPurchasable": true,
  "note": "string"
}