Skip to main content
GET
Consultar assinatura
Retorna os detalhes de uma assinatura.

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-id
string
required

ID público da credencial do merchant

client-secret
string
required

Secret da credencial do merchant

Path Parameters

subscriptionId
string<uuid>
required

Response

Detalhe da assinatura

id
string<uuid>

Identificador da assinatura.

subscription_status
enum<string>

Status atual da assinatura.

Available options:
ACTIVE,
PENDING,
TRIAL,
PAST_DUE,
CANCELLED
amount
integer

Valor da assinatura em centavos (congelado do plano na criação).

currency
string

Moeda ISO 4217 da assinatura.

grace_period_days
integer | null

Dias de tolerância após falha de cobrança.

grace_ends_at
string<date-time> | null

Fim da janela de carência após falha de cobrança.

trial_unit
enum<string> | null

Unidade do trial da assinatura.

Available options:
DAY,
WEEK,
MONTH,
YEAR
trial_duration
integer | null

Duração do trial da assinatura.

next_billing_date
string<date-time> | null

Data da próxima cobrança.

period_start_date
string<date-time> | null

Início do período vigente.

period_end_date
string<date-time> | null

Fim do período vigente.

cancellation_reason
string | null

Motivo do cancelamento: USER_ACTION ou PAYMENT_FAILED.

cancelled_at
string<date-time> | null

Data do cancelamento.

plan
object

Resumo do plano da assinatura.

customer
object

Resumo do cliente da assinatura.

payment_method
object

Método de pagamento padrão da assinatura.