Skip to main content
GET
Get the automatic top-up

Authorizations

Authorization
string
header
required

An Intent Leads API key, e.g. il_live_ followed by 32 letters and digits. Create one on the API and CLI page of the dashboard.

Response

The automatic top-up.

enabled
boolean
required

On when anything tops up automatically (the low-balance top-up, the billing-day top-up, or an older monthly card payment).

amount_usd
number | null
required

Added each time, $250 or more.

threshold_usd
number | null
required

The low-balance top-up runs when the available balance drops below this. Null when that part is off.

triggers
object
required
billing_day_by
enum<string> | null
required

Who does the billing-day top-up: auto (us) or subscription (an older monthly card payment).

Available options:
auto,
subscription
amount_choices_usd
number[] | null
required

With a monthly card payment, the amount is one of these.

paused
enum<string> | null
required

Why automatic top-ups are paused: a failed payment, 5 low-balance top-ups this billing month, or no card.

Available options:
payment_failed,
monthly_cap,
no_card
paused_at
string<date-time> | null
required
card
object | null
required
last
object | null
required