Get user's active subscription

Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with type, id, attributes).

JSON:API resource type. Always billing_subscription.

Local subscription identifier, represented as a string.

The user's active subscription, including its source, state, cycle, and limits. Each user has exactly one. The trial_*, cancel_*, and stripe_subscription_id fields are null when not applicable.

Unique, human-readable plan identifier. It corresponds to the user's active plan.

Plan name shown in the interfaces.

Plan billing model. free: No charge; tiered: Flat fee; metered: Charged by usage; hybrid: Flat fee plus usage.

Subscription source — stripe: Payment through Stripe; admin_granted: Admin grant; system_default: Plan assigned by the system.

Subscription lifecycle state — active: Active; trialing: In a trial period; past_due: Payment overdue with access still enabled; canceled: Ended; unpaid: Failed payments with no access; incomplete: First payment pending; incomplete_expired: First payment expired; paused: Paused.

ISO 8601 timestamp in UTC with an explicit Z suffix; for example, "2026-05-01T05:14:38Z". The *_at, *_end, *_start, and *_date fields follow this format. meta.datetime describes the same contract in the response.

ISO 8601 timestamp in UTC with an explicit Z suffix; for example, "2026-05-01T05:14:38Z". The *_at, *_end, *_start, and *_date fields follow this format. meta.datetime describes the same contract in the response.

Currency of the active cycle. MXN is Mexican pesos and USD, US dollars.

Billing cadence — once: One cycle with no automatic renewal; month: Monthly; year: Yearly.

true when the user has opted into overage billing on a hybrid plan. When so, effective_limit jumps from included_validations to monthly_validation_limit.

Validations included in the base quota before overage charges. null when the plan has no base quota.

Validation cap per subscription cycle. 0 allows no validations. On hybrid plans, it is the hard cap when overage_enabled is true; when it is false, effective_limit uses included_validations. On other models, it is the effective limit unless an admin override applies.

Cap on registered beneficiaries per account. -1 means uncapped; from 0, the value is enforced as the limit.

Maximum number of validations per import job. 0 allows no validation imports.

Effective validation limit for the current cycle. It includes admin overrides and, on hybrid plans, the overage_enabled rule. This is the value used to decide whether a validation is served or rejected.

true when source is stripe.

Stripe subscription identifier (sub_...). null when source is not stripe.

Reason recorded when the subscription was granted by an admin. null when source is not admin_granted.

true when the subscription is scheduled to cancel at the end of the current cycle.

Date and time the cancellation is scheduled for, in ISO 8601 UTC. null when no cancellation is scheduled through cancel_at.

Date and time the cancellation took effect, in ISO 8601 UTC. null while the subscription is active.

Date and time the trial period starts, in ISO 8601 UTC. null when there is no trial period.

Date and time the trial period ends, in ISO 8601 UTC. null when there is no trial period.

Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.

API version that processed the request.

API route prefix version (e.g. v1).

Unique request identifier (hex).

Companion descriptor present in the meta block of every response (and in the meta of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.

Always UTC: The canonical timezone for every datetime field in the body.

Always ISO 8601: Explicit Z suffix on every datetime.

Pagination or related links, present only when the endpoint returns a paginated collection.