Consultar saldo y cuota

Consulta cuánto puede gastar esta clave ahora mismo y su cuota; no se factura ni requiere saldo positivo.

GET/v1/usage

balance es lo que esta clave puede gastar ahora mismo: si la clave no tiene cuota, es el saldo de la cuenta; si la tiene, es la cuota restante de la clave. Las claves de miembros de equipo y departamentos se limitan además por la cuota restante del periodo. Una clave con cuota sigue cobrando del saldo de la cuenta: si el saldo de la cuenta se agota primero, las solicitudes devuelven 402 aunque balance aún tenga cuota.

La contabilidad es actualmente en CNY, aunque unit dice "USD": balance, remaining y los quota.* sin sufijo son valores en CNY. Para conciliar, lea directamente los campos _cny / _usd (_usd = _cny ÷ 6.8, fijo). Este endpoint solo acepta Authorization: Bearer y no usa la estructura de error estándar: decida según is_active, no solo por el código de estado HTTP.

Al terminar una tarea asíncrona, su consulta incluye en el usage del objeto raíz el cargo de la tarea cost / cost_cny / cost_usd; ver Cargos.

Consultar saldo y cuota

curl https://api.hop-base.com/v1/usage \
  -H "Authorization: Bearer $HOPBASE_API_KEY"

200application/json

{
  "is_active": true,
  "balance": 54.4,
  "remaining": 54.4,
  "unit": "USD",
  "ledger_currency": "CNY",
  "exchange_rate": {
    "cny_per_usd": 6.8,
    "basis": "fixed unit rate"
  },
  "balance_cny": 54.4,
  "balance_usd": 8,
  "quota": {
    "remaining": 54.4,
    "api_key_remaining": 54.4,
    "total": 68,
    "used": 13.6,
    "unlimited": false,
    "remaining_cny": 54.4,
    "remaining_usd": 8,
    "api_key_remaining_cny": 54.4,
    "api_key_remaining_usd": 8,
    "total_cny": 68,
    "total_usd": 10,
    "used_cny": 13.6,
    "used_usd": 2
  }
}

Encabezados

Authorization:obligatoriostring

Bearer sk-…: una clave de API creada en la consola; su grupo debe incluir el modelo solicitado

Respuesta

200Saldo y cuota; también es 200 si la clave caducó o el miembro está desactivado, con is_active: false

is_active:opcionalboolean

true si balance es mayor que 0

balance:opcionalnumber

Lo que esta clave puede gastar ahora mismo (en la moneda contable)

remaining:opcionalnumber

Igual que balance

unit:opcionalstring

Siempre "USD"; no indica la moneda

ledger_currency:opcionalstring

Moneda real de los importes sin sufijo, actualmente "CNY"

exchange_rate:opcionalobject

balance_cny:opcionalnumber

balance en CNY

balance_usd:opcionalnumber

balance en USD

quota:opcionalobject

Cuota de la clave

message:opcionalstring

Solo en casos anómalos: api key expired, member disabled, etc.

group:opcionalobject

El grupo al que pertenece esta clave; se omite en los grupos exclusivos

Errores

401Sin clave o sin prefijo sk-: missing or invalid api key; clave inexistente o desactivada: invalid api key

Encabezados

Respuesta

Errores

Páginas relacionadas