Edita plano | Dom Docs

🚧 Ao alterar um plano você não altera automaticamente as assinaturas vinculadas a ele. Para isso você deve listar as assinaturas criadas a partir do plano e atualizá-las uma a uma.

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

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

URL base da API

Token de autenticação

Path Params

iduuidrequired

ID do plano

Body Params

descriptionstringrequired

Nome/descrição do plano (máx. 80 caracteres)

valuefloatrequired

Valor padrão do plano (ex: 58.99)

frequencystringrequired

Valor numérico da frequência (ex: 1)

frequency_typestringrequired

Tipo de frequência: DAY, WEEK, MONTH ou YEAR

payment_methodsarrayrequired

Métodos de pagamento (ex: ["credit_card"])

external_referencestringoptional

Código de referência da loja

repetitionsintegeroptional

Número máximo de cobranças (0 = ilimitado)

billing_typestringoptional

Tipo de cobrança: prepaid, postpaid ou exact_day (default: prepaid)

billing_dayintegeroptional

Dia do mês para cobrança (1–28, obrigatório se billing_type = exact_day)

installmentsintegeroptional

Parcelas permitidas no cartão de crédito

retry_daysintegeroptional

Dias para retentativa após falha (default: 0)

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

Response

Choose an example:

application/json

Responses