Renomear ou arquivar plano

Muda só o nome e/ou o status do plano. Informe ao menos um dos dois.

  • ARCHIVED: o plano para de aceitar novas assinaturas (POST /v1/acquiring/subscriptions responde PLAN_ARCHIVED). As assinaturas existentes seguem sendo cobradas.
  • ACTIVE: volta a aceitar novas assinaturas.
  • Valor e regras não mudam: um preço novo é um plano novo.

Erros — corpo {"errors":[{"code":"...","msg":"..."}]}; msg detalha o campo quando é validação:

codeHTTPQuando aconteceO que fazer
INVALID_INPUT400Campo inválido ou fora do limite; msg diz qual e a regra.Corrija o campo indicado.
INVALID_JSON400Corpo não é um objeto JSON válido.Corrija o JSON.
MISSING_DOCUMENT_ID400Estabelecimento não informado.Envie o header X-Merchant-Document (ou documentId).
TENANT_REQUIRED400A credencial não identifica o tenant.Gere o token com as credenciais do seu tenant (POST /v1/oauth/token).
FEATURE_DISABLED403O módulo de assinaturas não está habilitado para o tenant.Peça a habilitação à Autra.
MERCHANT_NOT_FOUND404O documento não é de um estabelecimento do seu tenant.Confira o CPF/CNPJ do estabelecimento.
PLAN_NOT_FOUND404Plano não existe neste estabelecimento.Confira o id (planos são por estabelecimento).
PLAN_NAME_IN_USE409Já existe outro plano com este nome.Escolha outro nome.
PAYLOAD_TOO_LARGE413Corpo acima de 64 KiB.Reduza o corpo da requisição.
INVALID_DOCUMENT422Documento do estabelecimento malformado.CPF com 11 ou CNPJ com 14 dígitos, só números.
INTERNAL_ERROR500Falha interna.Tente de novo; persistindo, fale com o suporte com o horário da chamada.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID do plano (UUID)

Query Params
string

CPF/CNPJ do estabelecimento, quando não usar o header nem o corpo

Body Params

Nome e/ou status

string

Documento do estabelecimento (alternativa ao header X-Merchant-Document).

string
length ≤ 120

Novo nome, único por estabelecimento. 1 a 120 caracteres.

string
enum

ARCHIVED para de aceitar novas assinaturas (as existentes seguem cobradas); ACTIVE volta a aceitar.

Allowed:
Headers
string

CPF/CNPJ do estabelecimento (só números). Preferido; alternativa: documentId no corpo ou na query

Responses

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