Accounts

Your auto top-up settings

Whether auto top-up is on, the balance that triggers it and the amount it adds, a summary of the saved card, whether it is paused and why, and the 10 most recent attempts. available is false when auto top-up cannot be used on this platform right now. It is turned on with a top-up on the dashboard, which saves the card; it cannot be changed with an API key.

Requires account:r.

get/v1/auto-topup

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/auto-topup
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Auto top-up settings, saved card summary, pause state and recent attempts.

availableboolean required

False when auto top-up cannot be used on this platform right now. The other fields still describe your settings.

enabledboolean required

Whether auto top-up is on. It can be on and paused (paused_at).

threshold_centsinteger nullable required

When your balance falls below this, in CAD cents, your card is charged. Null before auto top-up was first turned on.

amount_centsinteger nullable required

The credit each auto top-up adds, in CAD cents, before tax. Always at least threshold_cents, so one top-up brings the balance back up to it. Null before auto top-up was first turned on.

paused_atstring date-time nullable required

When auto top-up was paused. Nothing is charged while it is paused. You resume it with "Top up to resume" in the Auto top-up section of the dashboard's Billing page, which is a new top-up that saves your card again. A pause for ACCOUNT_REVIEW cannot be resumed that way (see paused_reason).

paused_reason'DECLINED' | 'AUTHENTICATION_REQUIRED' | 'EXPIRED_CARD' | 'CARD_REMOVED' | 'BILLING_ADDRESS' | 'ACCOUNT_REVIEW' | 'ADMIN' | 'REFUND' | 'CHARGE_LIMIT' | 'null' nullable required

Why it was paused: the card was declined, needed authentication, expired or was removed; the billing address could not be used for tax; a payment was refunded and taken off the balance (REFUND); it reached its limit of 3 charges in 24 hours (CHARGE_LIMIT); the account is under review; or HonkIO staff paused it. You resume from every reason except ACCOUNT_REVIEW with "Top up to resume" on the dashboard. You cannot resume from ACCOUNT_REVIEW yourself. The account.auto_topup_paused webhook event carries the same value as reason.

cap_blockedboolean required

True while auto top-up is skipping charges because one would go over your balance or 30-day top-up limit.

setup_pendingboolean required

True when a setup was started and not finished: settings were chosen on the dashboard and the top-up that saves the card has not completed. They take effect only when it does. False once it completes, and after the settings are edited or auto top-up is turned off.

monthly_rent_centsinteger required

Monthly rent of the numbers you hold, in CAD cents. Auto top-up also tops up ahead of rent due within a day.

Changes

No recorded changes to this operation across all 1 revision of this API.