Skip to main content
GET
Ver una membresía

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 membresía (mem_…). Id de una membresía de un cliente.

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

"mem_01hzx8m4k2a7d9q3f5w6y8z0bc"

Response

OK.

La membresía de un cliente a un plan. Una membresía anulada o una compra que no se terminó no existen para la API: no se listan y su id responde not_found.

id
string
required

Id de una membresía de un cliente.

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

"mem_01hzx8m4k2a7d9q3f5w6y8z0bc"

object
string
required
Allowed value: "membership"
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 membresía es de alguien que no es cliente del estudio.

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

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

membership_plan_id
string
required

Id de un plan de membresía.

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

"mpl_01hzx8m4k2a7d9q3f5w6y8z0bc"

status
enum<string>
required

active, paused (congelada), suspended, pending_payment, cancelled o expired. La lista puede crecer: trata un valor que no conoces como una membresía que no da créditos.

Available options:
active,
paused,
suspended,
pending_payment,
cancelled,
expired
current_period_start
string<date-time>
required

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

Example:

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

current_period_end
string<date-time>
required

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

Example:

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

renews_at
string<date-time> | null
required

Cuándo se renueva sola: el fin del período actual si la membresía está active y su plan se renueva solo; si no, null.

Example:

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

next_credit_date
string<date> | null
required

La fecha local en que recibe los próximos créditos; null si no hay una prevista.

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

"2026-11-05"

started_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"

cancelled_at
string<date-time> | null
required

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

Example:

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

suspension_reason
string | null
required

Por qué se suspendió, como texto; null si no está suspendida.

discount
object | null
required

El descuento que tiene la membresía; null si no tiene.

active_freeze_id
string | null
required

El congelamiento en curso o programado; null si no hay. El detalle está en GET /v1/memberships/{id}/freezes.

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

"frz_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"

updated_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"