Skip to main content
GET
Consultar assinatura

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Parâmetros de caminho

subscriptionID
string<uuid>
obrigatório

ID da assinatura.

Resposta

Sucesso.

id
string<uuid>
customerId
string<uuid>

Id da inscrição.

productVersionId
string<uuid>

A versão do produto assinada. Define o preço cobrado, mesmo se o produto mudar depois.

status
enum<string>
Opções disponíveis:
trialing,
active,
past_due,
paused,
canceled
billingCycle
enum<string>
Opções disponíveis:
weekly,
monthly,
annual
collectionMethod
enum<string>

charge_automatically cobra sozinho; send_invoice envia a fatura para o cliente pagar.

Opções disponíveis:
charge_automatically,
send_invoice
billingMode
enum<string>

advance cobra no início do período; arrears, no fim.

Opções disponíveis:
arrears,
advance
anchor
string<date-time>

Data de referência a partir da qual os períodos são contados.

nextBillingDate
string<date-time> | null

Próxima cobrança.

startedAt
string<date-time>
canceledAt
string<date-time> | null
items
object[]

O que a assinatura cobra ou concede.