Skip to main content
Uma assinatura representa o relacionamento de cobranca entre uma organizacao e um plano. Ela rastreia o intervalo de plano selecionado (mensal ou anual), status de pagamento e quaisquer cupons aplicados. O status da assinatura determina o acesso da organizacao a funcionalidades pagas — uma assinatura ACTIVE significa acesso completo, enquanto PAST_DUE ou CANCELLED ativa funcionalidade degradada. Voce encontrara este objeto ao criar assinaturas, verificar status de cobranca ou visualizar proximas faturas.
​
subscriptionId
string
O identificador unico da assinatura (UUIDv7).
​
organizationId
string
O ID da organizacao.
​
planId
string
O ID do plano (UUIDv7).
​
planIntervalId
string
O ID do intervalo do plano (UUIDv7).
​
externalPlanRef
string|null
A referencia externa do plano.
​
externalFeeRef
string|null
A referencia externa da taxa.
​
currency
string
O codigo da moeda (ex.: BRL, USD).
​
status
string
O status da assinatura. Um de: ACTIVE, PAST_DUE, PAUSED, CANCELLATION_PENDING, CANCELLED.
​
pastDueReason
string|null
A razao pela qual a assinatura esta em atraso.
​
pastDueAt
string|null
Timestamp de quando a assinatura ficou em atraso (ISO 8601).
​
pausedBy
string|null
O agente que pausou a assinatura.
​
pausedAt
string|null
Timestamp de quando a assinatura foi pausada (ISO 8601).
​
cancelledBy
string|null
O agente que cancelou a assinatura.
​
cancelledAt
string|null
Timestamp de quando a assinatura foi cancelada (ISO 8601).
​
coupons
array
Os cupons aplicados a esta assinatura.
​
createdBy
string
O agente que criou a assinatura.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedBy
string
O agente que atualizou a assinatura por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
  "externalPlanRef": "sub_1Oy2pL2eZvKYlo2C0vIqMZ8y",
  "externalFeeRef": null,
  "currency": "BRL",
  "status": "ACTIVE",
  "pastDueReason": null,
  "pastDueAt": null,
  "pausedBy": null,
  "pausedAt": null,
  "cancelledBy": null,
  "cancelledAt": null,
  "coupons": [
    {
      "id": "019525fe-a1b4-7d3e-c5f8-2a4c6e8b0d1f",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "status": "ACTIVE",
      "externalRef": "di_1Oy2pL2eZvKYlo2C0vIqMZ8y",
      "createdAt": "2026-02-01T12:00:00.000Z",
      "updatedAt": "2026-02-01T12:00:00.000Z"
    }
  ],
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-02-01T12:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-02-01T12:00:00.000Z"
}