Pular para o conteúdo
Pagamentos

Criar plano

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

Cria um plano mensal. O valor é imutável: preço novo é um plano novo. Exige o header Idempotency-Key: repetir a mesma chave com o mesmo corpo devolve o mesmo plano; com outro corpo, 409.

Corpo da requisição

application/jsonobrigatório

V1PlanCreateInputInput

  • namestringobrigatório
    • tamanho 3–120
  • amountintegerobrigatório
    • faixa 1–100000000
  • externalReferencestringopcional
    • tamanho 1–120
    • chave string
    • valor string | number | boolean | null

    Uma destas formas

    • string
      • tamanho máx. 500
    • number
    • boolean

Respostas

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

200Deu certoapplication/json

A Idempotency-Key repetiu uma criação anterior com o mesmo corpo: devolve o MESMO plano, com idempotency_replay: true.

V1PlanEscrito

  • 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
  • idempotency_replaytruepode faltar
    • sempre true