GEThttps://api.veriko.mx/v1/billing/subscription

Consultar suscripción activa del usuario

Audiencia
public
Autenticación
API key
Permiso
billing:read_self

Devuelve la suscripción activa del usuario autenticado. La respuesta siempre contiene un recurso: si no existe una suscripción activa, el servidor asigna el plan predeterminado.

source distingue pagos mediante Stripe (stripe), concesiones administrativas (admin_granted) y planes asignados por el sistema (system_default). El resumen del ciclo (used, limit, remaining y resets_at) vive en meta.quota.

El consumo del ciclo también se consulta con GET /v1/usage/summary. Su resets_at es el fin del ciclo de cuota: coincide con current_period_end salvo en un plan anual, donde la cuota se reinicia cada mes y resets_at marca el fin del mes en curso. Los planes disponibles se consultan con GET /v1/plans.

Petición
curl -X GET 'https://api.veriko.mx/v1/billing/subscription' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200BillingSubscriptionResponse — Suscripción activa del usuario con plan, ciclo y cuota.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

type*string

Tipo de recurso JSON:API. Siempre billing_subscription.

p. ej. billing_subscription
id*string

Identificador local de la suscripción, expresado como cadena.

p. ej. 4218
attributes*object

Suscripción activa del usuario, con su origen, estado, ciclo y límites. Cada usuario tiene exactamente una. Los campos trial_*, cancel_* y stripe_subscription_id son nulos cuando no aplican.

plan_slugstring

Identificador único y legible del plan. Corresponde al plan activo del usuario.

p. ej. pro
plan_namestring

Nombre del plan que muestran las interfaces.

p. ej. Personal
billing_modelstring

Modelo de facturación del plan — free: Sin cobro; tiered: Cuota fija; metered: Cobro por consumo; hybrid: Cuota fija más consumo.

p. ej. hybrid
sourcestring

Origen de la suscripción — stripe: Pago mediante Stripe; admin_granted: Concesión administrativa; system_default: Plan asignado por el sistema.

p. ej. stripe
statusstring

Estado del ciclo de vida de la suscripción — active: Activa; trialing: En periodo de prueba; past_due: Con un cobro vencido y acceso todavía habilitado; canceled: Terminada; unpaid: Con cobros fallidos y sin acceso; incomplete: Primer pago pendiente; incomplete_expired: Primer pago vencido; paused: En pausa.

p. ej. active
current_period_startstring (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

p. ej. 2026-05-01T05:14:38Z
current_period_endstring (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

p. ej. 2026-05-01T05:14:38Z
currencystring

Moneda del precio — MXN: Pesos mexicanos; USD: Dólares estadounidenses.

p. ej. MXN
billing_intervalstring

Cadencia de facturación — once: Ciclo único, sin renovación automática; month: Cada mes; year: Cada año.

p. ej. month
overage_enabledboolean

true cuando el usuario aceptó cobro por excedente en un plan hybrid. En ese caso, effective_limit salta de included_validations a monthly_validation_limit.

p. ej. false
included_validationsinteger | nullanulable

Validaciones incluidas en la cuota base antes del cobro por excedentes. null cuando el plan no tiene cuota base.

p. ej. 500
monthly_validation_limitinteger

Tope de validaciones por ciclo de la suscripción. 0 no permite validaciones. En planes hybrid, es el tope duro cuando overage_enabled es true; cuando es false, effective_limit usa included_validations. En los demás modelos, es el límite efectivo salvo que exista un ajuste administrativo.

p. ej. 10000
beneficiaries_maxinteger

Tope de beneficiarios registrados por cuenta. -1 significa sin tope; desde 0, el valor se aplica como límite.

p. ej. -1
bulk_validations_maxinteger

Cantidad máxima de validaciones por trabajo de importación. 0 no permite importar validaciones.

effective_limitinteger

Límite efectivo de validaciones para el ciclo actual. Incorpora los ajustes administrativos y, en planes hybrid, la regla de overage_enabled. Es el valor contra el que se decide si una validación se atiende o se rechaza.

p. ej. 500
is_stripeboolean

true cuando source es stripe.

p. ej. true
stripe_subscription_idstring | nullanulable

Identificador de la suscripción en Stripe (sub_...). null cuando source no es stripe.

p. ej. sub_1OaBcDeFgHiJk2
grant_reasonstring | nullanulable

Motivo registrado cuando la suscripción fue otorgada por un administrador. null cuando source no es admin_granted.

p. ej. cortesía soporte
cancel_at_period_endboolean

true cuando la suscripción está programada para cancelarse al cierre del ciclo actual.

p. ej. false
cancel_atstring | nullanulable

Fecha y hora programada para la cancelación, en ISO 8601 UTC. null cuando no hay una cancelación programada mediante cancel_at.

p. ej. 2026-04-30T10:15:00Z
canceled_atstring | nullanulable

Fecha y hora en que la cancelación se consumó, en ISO 8601 UTC. null mientras la suscripción está activa.

p. ej. 2026-04-30T10:15:00Z
trial_startstring | nullanulable

Fecha y hora de inicio del periodo de prueba, en ISO 8601 UTC. null cuando no hay periodo de prueba.

p. ej. 2026-04-30T10:15:00Z
trial_endstring | nullanulable

Fecha y hora de fin del periodo de prueba, en ISO 8601 UTC. null cuando no hay periodo de prueba.

p. ej. 2026-04-30T10:15:00Z
metaobject

Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/billing/subscription
CódigoClaseDescripciónCuerpo
2002xxSuscripción activa del usuario con plan, ciclo y cuota.BillingSubscriptionResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
Errores de GET /v1/billing/subscription
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c