Endpoint: GET /subscriptions/subscriber/{subscriber_id}/payment/
Autenticação: Público (sem autenticação)
Lista os pagamentos pertencentes a um assinante. Como o UUID do assinante é não-adivinhável, este endpoint é exposto publicamente para suportar páginas de autoatendimento, onde o assinante consulta seu histórico de cobranças.

Pré-requisitos

  • O assinante precisa existir. Assinantes são criados por POST /subscriptions/plan/{plan_id}/subscribe/ ou pelo vendedor via API autenticada.

Parâmetros de rota

string
required
UUID do assinante.

Resposta

Array de objetos públicos de pagamento, do mais recente para o mais antigo.
string
UUID do pagamento.
string
Centavos de BRL como string (espelha o amount do plano no momento em que o pagamento foi agendado).
string
Um dos valores credit_card, boleto, pix.
string
Um dos valores pending, paid, failed, overdue, canceled.
string
Timestamp ISO-8601 do vencimento do pagamento.
string
Timestamp ISO-8601 em que o pagamento foi confirmado como pago, ou null.
string
Timestamp ISO-8601 em que o pagamento foi criado.
string
Cópia por conveniência do nome do plano de assinatura.
string
Cópia por conveniência da frequência do plano (monthly, etc.).
string
Cópia por conveniência do nome do assinante.
Inconsistência conhecida do campo amount: o valor é retornado como string em centavos (ex.: "4990" = R$ 49,90), diferente da convenção em centavos inteiros adotada em outros endpoints.

Erros

Exemplos