Skip to main content
GET
Ver el saldo de créditos de un cliente

Authorizations

Authorization
string
header
required

Clave del negocio. sk es una clave completa (todo lo que el rol de quien la creó puede dar) y rk una restringida a los permisos que se eligieron al crearla. Solo se usa desde un servidor: un pedido desde un navegador se rechaza con browser_not_allowed.

Headers

Craqui-Version
string

Versión de la API para este pedido (YYYY-MM-DD). Si no la mandas, se usa la versión fijada en la clave cuando se creó.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-12-01"

Path Parameters

id
string
required

El id del cliente (cli_…). Id de un cliente del estudio.

Pattern: ^cli_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

Response

OK.

El saldo de créditos de un cliente. total_credits es el saldo que vale: es el que ve el estudio y el que usa Craqui al reservar. La suma de grants puede no coincidir con él (por ejemplo, por días de gracia de una membresía o un lote que vence hoy).

object
string
required
Allowed value: "credit_balance"
livemode
boolean
required

false si el objeto es de tu estudio de prueba (claves crq_test_); true con claves crq_live_.

client_id
string
required

Id de un cliente del estudio.

Pattern: ^cli_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

total_credits
integer
required

El saldo del cliente; 0 si nunca tuvo créditos.

grants
object[]
required

Los lotes que se pueden usar (sin anular, con créditos y sin vencer), del que vence primero al último. Como mucho 100.

grants_has_more
boolean
required

true si el cliente tiene más de 100 lotes vivos; la lista completa está en GET /v1/credit_grants?client_id=…&status=active.