Endpoint: GET /subscriptions/subscriber/{subscriber_id}/
Autenticação: Público (sem autenticação)
Retorna um assinante pelo UUID, o plano ao qual ele está vinculado e a lista de seus pagamentos pending e failed. O UUID é não-adivinhável, então este endpoint é seguro para ser exposto em uma página de autoatendimento do assinante (ex.: link “gerenciar minha assinatura” enviado por e-mail).

Pré-requisitos

  • O assinante já deve existir — criado por POST /subscriptions/plan/{plan_id}/subscribe/ ou pelo vendedor via API autenticada.

Parâmetros de rota

string
required
UUID do assinante.

Resposta

string
UUID do assinante.
string
Nome completo do assinante.
string
E-mail do assinante.
string
Número de telefone (somente dígitos).
string
Prefixo de país E.164, ex.: +55.
string
CPF ou CNPJ.
string
Status do ciclo de vida do assinante. Um dos valores pending (aguardando primeiro pagamento), paid (em dia), failed (última cobrança falhou), overdue (vencido) ou canceled (cancelado).
string
Timestamp ISO-8601 da próxima cobrança programada.
string
Timestamp ISO-8601 em que o assinante foi criado.
object
Resumo do cartão tokenizado em arquivo, ou null. Campos: card_brand, last4_digits, holder_name.
object
Resumo embutido do plano:
  • id — UUID do plano.
  • name — nome do plano.
  • amount — centavos de BRL como string.
  • frequencyweeklyannual.
array
Todos os pagamentos pending e failed deste assinante, do mais recente para o mais antigo. Cada entrada usa o formato público de pagamento — veja Listar pagamentos do assinante (público).

Erros

Exemplos