Detalhar assinatura

Escopo: subscriptions:read — Assinantes, com dados de contato e CPF/CNPJ do responsável.

Uma assinatura pelo id (:subscriptionId — o id de Listar assinantes, ou o subscriptionId de um aluno). Responde qualquer status, inclusive INCOMPLETE. Assinatura de outro estabelecimento responde 404.

  • subscription: mesmo formato de Listar assinantes.
  • payment: situação pelas faturas em aberto da assinatura — UP_TO_DATE (nenhuma em aberto), PENDING (em aberto, no prazo) ou OVERDUE (vencida). paid é true só em UP_TO_DATE. oldestOpenDueDate é o vencimento da fatura em aberto mais antiga.
  • invoices: todas as faturas da assinatura, em qualquer status, da mais recente para a mais antiga. id é o id da cobrança no Asaas (pay_…); valueCents é o valor cheio e netAfterSplitCents o que fica para o estabelecimento depois de taxas e split. paymentDate e receiptUrl (link do comprovante) só vêm quando houve pagamento. paymentMethod: PIX, CREDIT, BANK_SLIP ou LOCAL (registrado à mão; aí localPaymentMethod diz como: CASH, PIX, DEBIT…). split é null sem split; com split, traz id, nome e valor.
  • students: alunos cujo cadastro aponta para esta assinatura (ficha completa em Detalhar aluno). Vazia quando a assinatura não tem aluno de turma.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

id de Listar assinantes, ou o subscriptionId de um aluno.

Query Params
string

uid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json