BillingOverview
subscriptions object[]
Todas las suscripciones de la cuenta, cada una con las acciones que permite. Una cuenta puede tener más de una: las plazas compradas se suman.
stripeactivePossible values: [checkout, admin, stripe_import, legacy, license]
Possible values: [licensed, metered]
plan objectnullable
Números cubiertos por una suscripción comprada por plazas (quantityMode: licensed). null en las medidas por uso (metered).
pendingChange objectnullable
Cambio programado — un downgrade vale al final del período pagado.
Possible values: [upgrade, downgrade]
card objectnullable
actions object
Lo que el panel permite hacer con esta suscripción ahora. Las acciones exigen la sesión del dueño de la cuenta — una API key recibe 403 owner_required.
account object
El lado de la cuenta en la pasarela: una moneda y una tarjeta predeterminada para todas las suscripciones.
card objectnullable
subscription objectdeprecated
Formato antiguo, de suscripción única. Se mantiene por compatibilidad; usa subscriptions.
plan object
Precio de un periodo. Un plan trimestral de 300 € cobra 300 € cada tres meses.
Unidad del periodo de facturación, tal como la define Stripe.
Possible values: [day, week, month, year]
Multiplicador de la unidad: month con intervalCount: 3 es un plan trimestral.
1Nombre derivado del par interval × intervalCount. custom es un periodo sin nombre (por ejemplo, cada cuatro meses).
Possible values: [daily, weekly, monthly, quarterly, semiannual, annual, custom]
Só em GET /billing/plans.
flat cobra un precio fijo por período; per_number, por número conectado más allá de los incluidos; graduated, por tramos (tiers).
Possible values: [flat, per_number, graduated]
tiers object[]
Tramos del modelo graduated, en orden. Vacío en los otros modelos.
Última cantidad que cubre el tramo; null en el último.
Plan fijo que se compra en copias: dos números en Start se vuelven una suscripción con dos copias, y cada copia cubre maxNumbers números.
currencyPrices object
Precio de un período en otras monedas, en centavos, por la moneda en minúsculas. La moneda base está en currency.
Techos del plan para contactos, campos personalizados, destinatarios por campaña, puestos de la bandeja y días de retención de mensajes. null es sin techo.
rateLimits object
Límites por minuto de cada API key en este plan, por categoría. null usa el predeterminado de la plataforma — ver Límites de uso.
Agrupa las variantes de período del mismo plan, como la mensual y la anual.
El plan se puede comprar ahora.
access object
grace todavía pasa, con la cabecera X-Joinotify-Billing-Warning; blocked responde 402.
Possible values: [ok, grace, blocked]
numbers object
El techo de números vigente. maxSource dice de dónde viene: el plan, el período de prueba o una decisión de la operación.
Possible values: [plan, trial, override]
entitlements object[]
Possible values: [active, expired, revoked, invalid]
usage objectnullable
{
"enabled": true,
"subscriptions": [
{
"id": "string",
"provider": "stripe",
"status": "active",
"origin": "checkout",
"quantityMode": "licensed",
"plan": {
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"billingModel": "string"
},
"numbers": 0,
"amountCents": 0,
"currency": "string",
"trialEndsAt": "2024-07-29T15:51:28.071Z",
"currentPeriodEnd": "2024-07-29T15:51:28.071Z",
"cancelAtPeriodEnd": true,
"pausedUntil": "2024-07-29T15:51:28.071Z",
"pendingUpdate": true,
"pendingChange": {
"kind": "upgrade",
"planSlug": "string",
"planName": "string",
"numbers": 0,
"effectiveAt": "2024-07-29T15:51:28.071Z"
},
"card": {
"brand": "string",
"last4": "string"
},
"actions": {
"change": true,
"cancel": true,
"resume": true,
"endTrial": true,
"cancelPendingChange": true,
"pause": true,
"unpause": true
}
}
],
"account": {
"currency": "string",
"card": {
"brand": "string",
"last4": "string"
}
},
"plan": {
"id": "string",
"slug": "string",
"name": "string",
"description": "string",
"features": [
"string"
],
"priceCents": 0,
"currency": "string",
"interval": "day",
"intervalCount": 1,
"billingPeriod": "daily",
"includedNumbers": 0,
"maxNumbers": 0,
"monthlyMessageLimit": 0,
"trialDays": 0,
"current": true,
"billingModel": "flat",
"tiers": [
{
"upTo": 0,
"unitAmountCents": 0,
"flatAmountCents": 0
}
],
"stackable": true,
"currencyPrices": {
"usd": 799,
"eur": 749
},
"maxContacts": 0,
"maxContactFields": 0,
"maxRecipientsPerBroadcast": 0,
"maxInboxSeats": 0,
"messageRetentionDays": 0,
"rateLimits": {
"send": 0,
"media": 0,
"default": 0
},
"family": "string",
"badge": "string",
"sellable": true
},
"access": {
"state": "ok",
"reason": "string",
"graceEndsAt": "2024-07-29T15:51:28.071Z"
},
"numbers": {
"connected": 0,
"free": 0,
"planIncluded": 0,
"included": 0,
"billable": 0,
"max": 0,
"maxSource": "plan"
},
"entitlements": [
{
"product": "string",
"status": "active",
"includedNumbers": 0,
"expiresAt": "2024-07-29T15:51:28.071Z"
}
],
"trialDays": 0,
"usage": {
"messages": 0,
"limit": 0
}
}