Skip to main content
GET
Consultar assinatura
O id é o identificador da assinatura, no formato sub_..., retornado na criação.
A resposta traz a fatura mais recente em latest_invoice (ou null se nenhuma fatura foi gerada). Para ver todas as faturas, use Listar faturas da assinatura.
Uma assinatura de outra conta retorna 404 (resource_missing), como se não existisse.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

Response

Assinatura encontrada

Assinatura. incomplete: a primeira fatura ainda não foi paga. incomplete_expired: a primeira fatura foi recusada. scheduled: a primeira cobrança está agendada (start_at). active: em dia. past_due: fatura em atraso. suspended: suspensa. canceled: cancelada. completed: todas as faturas previstas foram pagas.

id
string
Example:

"sub_4Hn8Qw2Rt6Yp1Zx3"

object
enum<string>
Available options:
subscription
code
string | null
Example:

"plano-anual-123"

status
enum<string>
Available options:
incomplete,
incomplete_expired,
scheduled,
active,
past_due,
suspended,
canceled,
completed
currency
string
Example:

"brl"

description
string | null
interval
enum<string>
Available options:
day,
week
interval_count
integer
billing_type
enum<string>
Available options:
prepaid
amount
integer

Total dos itens, em centavos, sem descontos ou acréscimos

items
object[]
discounts
object[]
increments
object[]
max_invoices
integer | null
invoices_paid
integer

Quantidade de faturas pagas

minimum_price
integer | null

Aceito e devolvido pela API, mas ainda não é aplicado na cobrança

payment_method
object
statement_descriptor
string | null
start_at
string | null
next_billing_at
string | null
created_at
string
customer
object
latest_invoice
object | null

Fatura de um ciclo da assinatura. processing: em processamento. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: paga. failed: recusada (veja failure_reason). canceled: cancelada. refunded e partially_refunded: estornada. chargeback: contestada.

metadata
object