Obter detalhes do plano

GEThttps://api.sandbox.cefispay.com.br/api/v1/plan

Retorna os detalhes de um plano específico, com base no ID fornecido. Nota: É necessário fornecer o ID do plano para obter os detalhes.

Respostas

200Detalhes do plano retornados com sucesso

Corpo da resposta

application/json

idstring
O ID do plano.
uuidstring
O UUID do plano.
namestring
O nome do plano.
public_namestring
O nome público do plano.
methodsarray
Os métodos de pagamento do plano.
valuenumber
O valor do plano.
finenumber
A multa do plano.
interestnumber
O juros do plano.
intervalnumber
O intervalo do plano.
interval_typestring
O tipo de intervalo do plano.
chargesnumber
As cobranças do plano.
trial_daysnumber
Os dias de teste do plano.
retry_daysnumber
Os dias de tentativa do plano.
automatic_cancelboolean
O cancelamento automático do plano.
urlstring
A URL do plano.
custom_layout_enabledboolean
A habilitação do layout personalizado do plano.
custom_layoutstring
O layout personalizado do plano.
redirect_uristring
A URI de redirecionamento do plano.
statusstring
Valores permitidos:activeinactive
custom_fieldsarray
Os campos personalizados do plano.
billing_productsarray
Os produtos de cobrança do plano.
companyobject
A empresa do plano.
charge_enabledboolean
A habilitação da cobrança do plano.
billing_settingsobject
As configurações de cobrança do plano.
dunningobject
O dunning do plano.
created_atstringdate-time
A data e hora em que o plano foi criado.
updated_atstringdate-time
A data e hora em que o plano foi atualizado.

Exemplo

{
  "id": "string",
  "uuid": "string",
  "name": "string",
  "public_name": "string",
  "methods": [
    "string"
  ],
  "value": 0,
  "fine": 0,
  "interest": 0,
  "interval": 0,
  "interval_type": "string",
  "charges": 0,
  "trial_days": 0,
  "retry_days": 0,
  "automatic_cancel": true,
  "url": "string",
  "custom_layout_enabled": true,
  "custom_layout": "string",
  "redirect_uri": "string",
  "status": "active",
  "custom_fields": [
    "string"
  ],
  "billing_products": [
    "string"
  ],
  "company": {},
  "charge_enabled": true,
  "billing_settings": {},
  "dunning": {},
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

401Não autenticado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}

422Erro na validação dos dados

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}

500Erro inesperado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

Respostas

Credenciais

Resposta