Payload — Subscription - Upag Documentation

id:

{
  "id": "sub_xyz789abc",
}

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)

customer:

{
  "customer": "cus_ahwDXrgYvur89iPs",
}

customer : string.
ID do cliente, começando com cus_

paymentMethod:

{
  "paymentMethod": "pm_abc123xyz",
}

paymentMethod : string.
ID do método de pagamento, começando com pm_

status:

{
  "status": "active",
}

status : string.
Status atual da assinatura (ex.: active, canceled, past_due, trialing, incomplete, paused, void)

currency:

{
  "currency": "BRL",
}

currency : string.
Código da moeda (ex.: BRL)

interval:

{
  "interval": "month",
}

interval : string.
Intervalo de cobrança (ex.: day, month, year)

intervalCount:

{
  "intervalCount": 1,
}

intervalCount : number.
Quantidade de intervalos entre cada cobrança

cancelAtPeriodEnd:

{
  "cancelAtPeriodEnd": false,
}

cancelAtPeriodEnd : boolean.
Se a assinatura será cancelada ao final do período atual

startDate:

{
  "startDate": 1731622178441,
}

startDate : number.
Timestamp Unix de início da assinatura

endDate:

{
  "endDate": null,
}

endDate : number | null.
Timestamp Unix de fim da assinatura. Pode ser null

trialStartDate:

{
  "trialStartDate": null,
}

trialStartDate : number | null.
Início do período de trial. Pode ser null

trialEndDate:

{
  "trialEndDate": null,
}

trialEndDate : number | null.
Fim do período de trial. Pode ser null

currentPeriodStart:

{
  "currentPeriodStart": 1731622178441,
}

currentPeriodStart : number.
Início do período atual de cobrança (timestamp Unix)

currentPeriodEnd:

{
  "currentPeriodEnd": 1734300578441,
}

currentPeriodEnd : number.
Fim do período atual de cobrança (timestamp Unix)

createdAt:

{
  "createdAt": 1731622178441,
}

createdAt : number.
Timestamp Unix de criação

updatedAt:

{
  "updatedAt": 1731622178441,
}

updatedAt : number.
Timestamp Unix da última atualização

canceledAt:

{
  "canceledAt": null,
}

canceledAt : number | null.
Timestamp Unix do cancelamento. Pode ser null

items:

{
  "items": [
    {
      "id": "si_abc123",
      "product": "prod_xyz",
      "price": "pri_xyz",
      "name": "Plano Mensal",
      "amount": 9900,
      "quantity": 1,
      "createdAt": 1731622178441,
      "updatedAt": 1731622178441
    }
  ]
}

items : array.
Lista de itens da assinatura. Cada item contém: id (string, prefixo si_), product (ID do produto), price (ID do preço), name, amount (centavos), quantity, createdAt, updatedAt

Primeiros passos

Clientes

Métodos de Pagamento

Pagamentos

Sessões de Checkout

Faturas

Assinaturas

Webhooks

Payload — Subscription

Estrutura

Atributos

​ Estrutura

​Atributos

Estrutura

Atributos