Referência

id:

{
  "id": "sub_abc123xyz",
}

id : string.
Identificador único da assinatura, começando com sub_

livemode:

{
  "livemode": false,
}

livemode : boolean.
Indica se a assinatura está em modo de produção (true) ou teste (false)

customerId:

{
  "customerId": "cus_ahwDXrgYvur89iPs",
}

customerId : string.
ID do cliente associado à assinatura. Veja a referência completa aqui

paymentMethodId:

{
  "paymentMethodId": "pm_abc123xyz",
}

paymentMethodId : string | null.
ID do método de pagamento utilizado para as cobranças recorrentes. Veja a referência completa aqui

status:

{
  "status": "active",
}

status : string.
Status atual da assinatura

Status	Descrição
`active`	A assinatura está ativa e sendo cobrada
`trialing`	A assinatura está em período de teste
`past_due`	O pagamento está atrasado
`canceled`	A assinatura foi cancelada
`unpaid`	A assinatura está inadimplente
`incomplete`	A assinatura está pendente de confirmação

interval:

{
  "interval": "month",
}

interval : string.
Intervalo de cobrança: day, week, month, year

intervalCount:

{
  "intervalCount": 1,
}

intervalCount : number.
Quantidade de intervalos entre cada cobrança. Ex.: intervalCount: 3 com interval: month = cobrança a cada 3 meses

cancelAtPeriodEnd:

{
  "cancelAtPeriodEnd": false,
}

cancelAtPeriodEnd : boolean.
Se true, a assinatura será cancelada ao final do período atual em vez de renovar

currentPeriodStart / currentPeriodEnd:

{
  "currentPeriodStart": "2024-11-15T10:00:00.000Z",
  "currentPeriodEnd": "2024-12-15T10:00:00.000Z",
}

currentPeriodStart / currentPeriodEnd : string | null.
Datas de início e fim do período de cobrança atual em formato ISO 8601

trialStartDate / trialEndDate:

{
  "trialStartDate": null,
  "trialEndDate": null,
}

trialStartDate / trialEndDate : string | null.
Datas do período de teste em formato ISO 8601. null se não há período de teste

cancellationReason:

{
  "cancellationReason": null,
}

cancellationReason : string | null.
Motivo do cancelamento. Valores: low_quality, missing_features, other, switched_service, too_complex, too_expensive, unused

items:

{
  "items": [
    {
      "id": "si_abc123xyz",
      "subscriptionId": "sub_abc123xyz",
      "productId": "prod_xyz789abc",
      "priceId": "price_def456ghi",
      "name": "Plano Pro",
      "amount": 9900,
      "quantity": 1,
      "createdAt": "2024-11-15T10:00:00.000Z",
      "updatedAt": "2024-11-15T10:00:00.000Z"
    }
  ]
}

items : array.
Lista de itens da assinatura. Cada item contém id, subscriptionId, productId, priceId, name, amount (em centavos), quantity, createdAt e updatedAt

canceledAt:

{
  "canceledAt": null,
}

canceledAt : string | null.
Data em que a assinatura foi cancelada em formato ISO 8601. null se ativa

createdAt:

{
  "createdAt": "2024-11-15T10:00:00.000Z",
}

createdAt : string.
Data de criação da assinatura em formato ISO 8601

updatedAt:

{
  "updatedAt": "2024-11-15T10:00:00.000Z",
}

updatedAt : string.
Data da última atualização da assinatura em formato ISO 8601

Primeiros passos

Clientes

Métodos de Pagamento

Pagamentos

Sessões de Checkout

Faturas

Assinaturas

Webhooks

Estrutura

Atributos:

​ Estrutura

​Atributos:

Estrutura

Atributos: