Dom Docs
Dom Pagamentos

Edita plano

POSThttps://{apiUrl}/recurrence/plan/{id}

Atualizado em · 1 min de leitura

Endpoint: POST https://{apiUrl}/recurrence/plan/{id}

Atualiza as configurações de um plano de assinatura existente.

Parâmetros

POSThttps://{apiUrl}/recurrence/plan/{id}
URL base da API
Token de autenticação
Path Params
idstringrequired

Identificador único do plano (UUID)

Body Params
namestringoptional

Novo nome do plano

amountfloatoptional

Novo valor do plano

intervalintegeroptional

Intervalo de cobrança

interval_typestringoptional

Tipo: "day", "month" ou "year"

descriptionstringoptional

Descrição do plano

curl --request POST \
  --url "https://{apiUrl}/recurrence/plan/{id}" \
  --header "Content-Type: application/json" 
  --data '{}'
Response

Choose an example:

application/json

Alterar um plano não modifica automaticamente as assinaturas já criadas a partir dele. Você deve listar as assinaturas do plano e atualizá-las individualmente se necessário.

Exemplo de resposta

json
{
  "status": "OK",
  "code": 200,
  "id": "plano-uuid-aqui"
}
Campos da resposta
statusstring

OK em caso de sucesso, FAIL em caso de erro

codeinteger

Código HTTP da operação

idstring

UUID do plano editado

Esta página foi útil?