Retrieve a customer’s auto top-up

GET

https://api.runledger.co/v1/customers/:customer_id/auto_top_up

GET

/v1/customers/:customer_id/auto_top_up

curl https://api.runledger.co/v1/customers/cus_9sF2kq81LmQz/auto_top_up \
     -H "Authorization: Bearer <api_key>"

{
  "id": "atu_7bN3xV9qLc",
  "object": "string",
  "customer": "string",
  "credit_type": "ai_credits",
  "pool": "purchased",
  "enabled": true,
  "threshold": "500",
  "target_balance": "5000",
  "status": "active",
  "consecutive_failures": 1,
  "livemode": true,
  "created_at": "2024-01-15T09:30:00Z",
  "monthly_limit": {
    "amount": 1500,
    "currency": "usd"
  },
  "purchased_this_month": {
    "amount": 1500,
    "currency": "usd"
  },
  "last_attempt": {
    "status": "pending",
    "at": "2024-01-15T09:30:00Z",
    "credits": "4500",
    "payment": "string",
    "failure_code": "string"
  },
  "actor": {
    "type": "user",
    "id": "usr_4tN8vB2cXk",
    "name": "Claude Code",
    "on_behalf_of": "usr_4tN8vB2cXk",
    "client": "claude-code"
  }
}

Returns the setting, its last attempt and what it has bought this month.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

customer_idstringRequired

The customer ID (cus_...).

Response

The customer’s auto top-up.

idstring

object"auto_top_up"

customerstring

credit_typestring

poolstring

enabledboolean

thresholdstring

target_balancestring

statusenum

active tops up. disabled stopped after three failures in a row, or because you turned it off. Set it again to re-enable.

Allowed values:

consecutive_failuresinteger

livemodeboolean

created_atdatetime

monthly_limitobjectOptional

An amount of money in the currency's minor unit.

purchased_this_monthobjectOptional

What automatic purchases have cost since the start of the calendar month (UTC).

last_attemptobjectOptional

actorobjectOptional

Who last changed it.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error