Pular para o conteúdo principal
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
obrigatório

ID da assinatura.

Pattern: ^sub_[0-9A-Za-z]{22}$
Exemplo:

"sub_2Kp7rWqT0aLm4XcVb8NzJe"

Resposta

Sucesso.

id
string
obrigatório
Pattern: ^sub_[0-9A-Za-z]{22}$
Exemplo:

"sub_2Kp7rWqT0aLm4XcVb8NzJe"

customerId
string<uuid>
obrigatório

Id da inscrição.

productVersionId
string<uuid>
obrigatório

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

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

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

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

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

startedAt
string<date-time>
obrigatório
collectionMethod
enum<string>

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

Opções disponíveis:
charge_automatically,
send_invoice
nextBillingDate
string<date-time> | null

Próxima cobrança.

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

O que a assinatura cobra ou concede.