Pular para o conteúdo
Pagamentos

Listar assinaturas

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/subscriptions
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

Paginação por cursor. Filtros por status, planId e externalReference. Assinatura ativa não quer dizer mês pago: overdueInvoices conta as faturas vencidas sem pagamento.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional
    • um de"active""paused""canceled"
  • planIdstringopcional
  • externalReferencestringopcional
    • tamanho 1–120
  • cursorstringopcional
  • limitintegeropcional
    • padrão 25
    • faixa 1–100

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de assinaturas, da mais nova para a mais antiga. data: [] também é sucesso. Com externalReference, a página pode trazer menos itens que limit e ainda ter nextCursor: siga o cursor até null.

  • Cada item — V1Subscription

    • idstring
    • statusstring
      • um de"active""paused""canceled"
    • pauseReasonstring | null
      • um de"merchant""payment_refused""card_revoked"
    • planIdstring
    • planNamestring
    • amountinteger

      Valor mensal congelado na assinatura, em centavos.

    • currency"BRL"
      • sempre "BRL"
    • paymentMethodstring
      • um de"pix""card"
    • billingModestring
      • um de"checkout""automatic_card"

    • Autorização de débito mensal do comprador, quando houve. Nunca traz o token do cartão.

      • statusstring
        • um de"storing""active""unconfirmed""revoked""unavailable""superseded"
      • brandstring | null
      • last4string | null
      • namestring
      • emailstring
      • taxIdLast4string
    • startDatestring

      Primeiro vencimento (YYYY-MM-DD). Âncora do dia de cobrança.

    • nextCycleNumberinteger
    • nextDueDatestring | null

      Próximo vencimento (YYYY-MM-DD); null quando cancelada.

    • overdueInvoicesinteger

      Faturas vencidas sem pagamento confirmado.

    • externalReferencestring | null
      • chave string
      • valor string | number | boolean | null

      Uma destas formas

      • string
      • number
      • boolean
    • createdAtstring
    • canceledAtstring | null
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.