Dom Docs
Dom Pagamentos

Alterar plano da assinatura

POST/recurrence/subscriptions/{id}/change-plan

Atualizado em · 2 min de leitura

Migra uma assinatura para outro plano. Um novo ID de assinatura é gerado.

Migra uma assinatura existente para as configurações de um novo plano. Após a migração, o ID anterior da assinatura é inativado e um novo ID é gerado.

Atenção: Após a alteração, utilize o novo ID retornado na resposta para referenciar a assinatura.

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

UUID da assinatura

Body Params
plan_idstringrequired

ID do novo plano

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

Choose an example:

application/json

Parâmetros

Path

ParâmetroTipoObrigatórioDescrição
idstringSimUUID da assinatura atual

Headers

ParâmetroTipoObrigatórioDescrição
AuthorizationstringSimChave privada no formato Bearer {token}

Body

ParâmetroTipoObrigatórioDescrição
plan_idstringSimID do novo plano

Exemplo de requisição

bash
curl --request POST \
  --url https://{apiUrl}/recurrence/subscriptions/{id}/change-plan \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plan_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'
Responses
Esta página foi útil?