Pular para o conteúdo
Pagamentos

Listar planos

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

Planos mensais do workspace. Filtro opcional por active (true = aceita assinatura nova; false = arquivado). Valores em centavos (BRL).

Parâmetros de consulta

Vão na querystring, depois do ?.

  • activestringopcional
    • um de"true""false"

Respostas

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

200Deu certoapplication/json

Os planos do workspace, do mais novo para o mais antigo. data: [] também é sucesso.

  • Cada item — V1Plan

    • idstring
    • namestring
    • amountinteger

      Valor mensal em centavos (BRL).

    • currency"BRL"
      • sempre "BRL"
    • interval"month"
      • sempre "month"
    • activeboolean

      false = arquivado: não aceita assinatura nova.

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

      Uma destas formas

      • string
      • number
      • boolean
    • createdAtstring