Skip to main content
GET
Ver una cuota

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 de la cuota (fee_…). Id de una cuota.

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

"fee_01hzx8m4k2a7d9q3f5w6y8z0bc"

Response

OK.

Una cuota que el estudio le cobra a un cliente: una membresía, un pack, una oferta de bienvenida o un pago adelantado de varios meses.

id
string
required

Id de una cuota.

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

"fee_01hzx8m4k2a7d9q3f5w6y8z0bc"

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

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

client_id
string | null
required

El cliente. null si la cuota es de alguien que no es cliente del estudio.

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

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

type
enum<string>
required

membership, credit_pack, intro_offer o advance_payment (un pago adelantado que cubre varios meses de una membresía). La lista puede crecer.

Available options:
membership,
credit_pack,
intro_offer,
advance_payment
due_date
string<date>
required

Fecha local del negocio, YYYY-MM-DD.

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

"2026-11-05"

amount_due
object
required

El monto de la cuota. En una cuota covered es el precio que hubiera tenido ese mes: no se debe, porque lo pagó el pago adelantado.

amount_paid
object
required
amount_refunded
object
required
status
enum<string>
required
  • open: a pagar, todavía en fecha.
  • overdue: vencida y sin pagar.
  • paid: pagada (también si después se devolvió una parte).
  • refunded: se devolvió entera.
  • void: anulada; no se debe.
  • covered: un mes que cubre un pago adelantado (advance_payment_fee_id); no se debe.

Para saber cuánto debe un cliente, suma amount_due − amount_paid solo de las cuotas open y overdue. La lista puede crecer: trata un valor que no conoces como una cuota que no se debe.

Available options:
open,
overdue,
paid,
refunded,
void,
covered
membership_id
string | null
required

La membresía de la cuota, en las de tipo membership y advance_payment; null en las demás.

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

"mem_01hzx8m4k2a7d9q3f5w6y8z0bc"

credit_grant_id
string | null
required

El lote de créditos que se cobró con esta cuota; null si no hay.

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

"cgr_01hzx8m4k2a7d9q3f5w6y8z0bc"

advance_payment_fee_id
string | null
required

En una cuota covered, la cuota del pago adelantado que la cubre. null en las demás, y también en una covered cuyo pago adelantado ya no existe.

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

"fee_01hzx8m4k2a7d9q3f5w6y8z0bc"

created_at
string<date-time>
required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-11-05T19:00:00-03:00"