Read prepaid managed-call credit

GET

/v1/billing/prepaid

const url = 'https://api.vocapable.com/v1/billing/prepaid';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/billing/prepaid \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

PrepaidWallet

object

currency

required

Currency

string

prepaid_balance_minor

required

Prepaid Balance Minor

integer

prepaid_reserved_minor

required

Prepaid Reserved Minor

integer

prepaid_available_minor

required

Prepaid Available Minor

integer

spend_cap_minor

required

Any of:

integer
null

integer

spend_cap_period

required

Any of:

string
null

string

low_balance_threshold_minor

required

Any of:

integer
null

integer

funding_min_minor

required

Funding Min Minor

integer

>= 1

funding_max_minor

required

Funding Max Minor

integer

>= 1

applies_to

Applies To

string

default: managed_verified_number_test_calls_only

Allowed value: managed_verified_number_test_calls_only

auto_recharge_supported

Auto Recharge Supported

boolean

funding_intents

required

Funding Intents

Array<object>

PrepaidFundingIntent

object

required

string

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

status

required

Status

string

checkout_url

Any of:

string
null

string

expires_at

Any of:

string
null

string format: date-time

pending

Pending

boolean

receipts

required

Receipts

Array<object>

PrepaidReceipt

object

required

string

funding_intent_id

required

Funding Intent Id

string

kind

required

Kind

string

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

created_at

required

Created At

string format: date-time

reconciliations

required

Reconciliations

Array<object>

PrepaidReconciliation

A customer-visible hold exception; the opaque callback correlation stays private.

object

required

string

contact_attempt_id

required

Contact Attempt Id

string

status

required

Status

string

reason

required

Any of:

string
null

string

provider_call_id

required

Any of:

string
null

string

actual_billed_seconds

required

Any of:

string
null

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

actual_amount_minor

required

Any of:

integer
null

integer

required_at

required

Any of:

string
null

string format: date-time

resolved_at

required

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

Example

{
  "applies_to": "managed_verified_number_test_calls_only",
  "auto_recharge_supported": false,
  "funding_intents": [
    {
      "pending": false
    }
  ]
}