Pular para o conteúdo principal
POST
Criar pedido
string
padrão:"purchase"
Para que serve o pedido. Valores possíveis: purchase, renew, upgrade.
string
obrigatório
O slug do plano que está sendo comprado, renovado ou para o qual se faz upgrade.
integer
obrigatório
Quantos meses comprar: 1, 3 ou 12. O plano Economy aceita apenas 1. Qualquer outro valor retorna INVALID_MONTHS. Um pedido de 3 meses tem 5% de desconto e um pedido de 12 meses tem 15% de desconto sobre o preço mensal; price e discount já incluem isso.
string
Um código de cupom de desconto opcional.
O pedido precisa de dados de cobrança completos: verifique complete em Obter dados de cobrança.
Um pedido renew exige que o plano de destino seja igual ao plano atual da conta; um pedido upgrade exige que ele seja estritamente maior. Use type: "purchase" quando ainda não houver um plano ativo desse tipo.

Resposta

object

Respostas de erro

string
O código de erro que indica o motivo da falha. Valores possíveis:
  • AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: o header Authorization está ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).
  • API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (403).
  • USER_NOT_FOUND: o usuário autenticado não foi encontrado.
  • INVALID_PAYLOAD: o body da requisição falhou na validação.
  • BILLING_DETAILS_INCOMPLETE: os dados de cobrança não estão completos (nome, endereço e, no Brasil, CPF/CNPJ). Salve-os com Atualizar dados de cobrança e tente de novo.
  • MISSING_PLAN_OR_MONTHS: plan ou months está ausente.
  • INVALID_MONTHS: months não é 1, 3 ou 12, ou não é 1 para o plano Economy.
  • INVALID_PLAN: o slug do plano não existe.
  • NOT_AN_UPGRADE: para type: "upgrade", o plano de destino não é maior que o atual.
  • PLAN_MISMATCH_FOR_RENEWAL: para type: "renew", o plano de destino não corresponde ao atual.
  • PENDING_ORDER_LIMIT_REACHED: há pedidos não pagos em aberto em quantidade excessiva.
  • INTERNAL_SERVER_ERROR: ocorreu um erro inesperado no servidor.
Última modificação em 28 de outubro de 2026