Get account credit
title: Get the account's stamp credit¶
Get the caller's prepaid stamp credit (the account balance used to pay for stamping) and the price of one stamp. Read-only. This is not the outstanding balance of an invoice (that is get_invoice_balance). Every sign_invoice debits the stamp price from this credit (invoices, credit notes and payment complements alike); when it does not cover it sign_invoice answers insufficient_balance and nothing is stamped. Returns {billing: on, balance, currency, stamp_price, stamp_currency, stamps_affordable (null if the credit is kept in another currency than the price)} or {billing: off} when stamps are free. create_account_topup_link adds credit.
Alcance (scope): invoices:read · Características: Solo lectura, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
issuer |
string | Sí | Id of the issuer the call acts for, from list_issuers. |
Esquema de entrada (JSON Schema)¶
{
"type": "object",
"properties": {
"issuer": {
"type": "string",
"format": "uuid",
"description": "Id of the issuer the call acts for, from list_issuers."
}
},
"additionalProperties": false,
"required": [
"issuer"
]
}