Account

addressAddressrequired

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e

accountIdinteger<int64>required

onchainStatestring

Possible values: [NONE, FUNDED, ACTIVE, ENDED]

creditsMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

escrowMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

paygBudgetMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

maxPaygPriceMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

maxRenewPriceMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

renewTierIdinteger

flags objectrequired

autoRenewbooleanrequired

paygEnabledbooleanrequired

paygAutoTopupboolean

paygClosingboolean

paygDisabledAtMs(integer | null)<int64>nullable

current object

oneOf

• PlanBlock
• null

A plan block as the contract stores it (PlanBlockV1).

blockIdinteger<int64>required

tierIdintegerrequired

tierstringrequired

Tier slug.

kindstringrequired

Possible values: [New, Queued, Upgrade, AutoRenew]

startMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

endMs(integer | null)<int64>nullablerequired

Null for a no-period (floating) block.

periodMsinteger<int64>required

Possible values: >= 0

monthsintegerrequired

capRuinteger<int64>required

Relay Units.

Possible values: >= 0

bonusRuinteger<int64>

Relay Units.

Possible values: >= 0

tariffAtPurchaseinteger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

paygPriceMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

floatingboolean

maxSendersintegerrequired

pricePaidMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

queued object

oneOf

• PlanBlock
• null

A plan block as the contract stores it (PlanBlockV1).

blockIdinteger<int64>required

tierIdintegerrequired

tierstringrequired

Tier slug.

kindstringrequired

Possible values: [New, Queued, Upgrade, AutoRenew]

startMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

endMs(integer | null)<int64>nullablerequired

Null for a no-period (floating) block.

periodMsinteger<int64>required

Possible values: >= 0

monthsintegerrequired

capRuinteger<int64>required

Relay Units.

Possible values: >= 0

bonusRuinteger<int64>

Relay Units.

Possible values: >= 0

tariffAtPurchaseinteger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

paygPriceMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

floatingboolean

maxSendersintegerrequired

pricePaidMicrointeger<int64>required

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

periodIdinteger

grant object

ruinteger<int64>

Relay Units.

Possible values: >= 0

expiryMsinteger<int64>

Unix time in milliseconds.

Possible values: >= 0

senderCountintegerrequired

lastSeqinteger<int64>

mirror objectrequired

eventSeqinteger<int64>required

blockTsMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

Account

{
  "address": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
  "accountId": 0,
  "onchainState": "NONE",
  "creditsMicro": 0,
  "escrowMicro": 0,
  "paygBudgetMicro": 0,
  "maxPaygPriceMicro": 0,
  "maxRenewPriceMicro": 0,
  "renewTierId": 0,
  "flags": {
    "autoRenew": true,
    "paygEnabled": true,
    "paygAutoTopup": true,
    "paygClosing": true
  },
  "paygDisabledAtMs": 0,
  "current": {
    "blockId": 0,
    "tierId": 0,
    "tier": "string",
    "kind": "New",
    "startMs": 0,
    "endMs": 0,
    "periodMs": 0,
    "months": 0,
    "capRu": 0,
    "bonusRu": 0,
    "tariffAtPurchase": 0,
    "paygPriceMicro": 0,
    "floating": true,
    "maxSenders": 0,
    "pricePaidMicro": 0
  },
  "queued": {
    "blockId": 0,
    "tierId": 0,
    "tier": "string",
    "kind": "New",
    "startMs": 0,
    "endMs": 0,
    "periodMs": 0,
    "months": 0,
    "capRu": 0,
    "bonusRu": 0,
    "tariffAtPurchase": 0,
    "paygPriceMicro": 0,
    "floating": true,
    "maxSenders": 0,
    "pricePaidMicro": 0
  },
  "periodId": 0,
  "grant": {
    "ru": 0,
    "expiryMs": 0
  },
  "senderCount": 0,
  "lastSeq": 0,
  "mirror": {
    "eventSeq": 0,
    "blockTsMs": 0
  }
}