Recorrência & Mensalidades (NFS-e)

Pausar ou Reativar Contrato

Alterna instantaneamente o status do contrato entre ativo e pausado. Ao pausar, as emissões automáticas do cronograma diário são suspensas até a reativação.

PATCH
https://api.nfer.me
/v1/recurring-contracts/{id}/toggle

Authorizations

X-API-Key
string
header
required

Chave de API emitida no painel NFER enviada no header da requisição.

Path Parameters

id
string<uuid>
required

UUID do contrato.

Exemplo:a819c940-bf72-46a2-9659-192518e11a91

Response

application/json

Status do contrato alternado com sucesso.

id
string<uuid>
opcional

Identificador único do recurso.

Exemplo:a819c940-bf72-46a2-9659-192518e11a91
active
boolean
opcional
Exemplo:false
message
string
opcional

Mensagem descritiva do erro.

Exemplo:Contrato pausado com sucesso
Pausar ou Reativar Contrato
curl --request PATCH \
  --url https://api.nfer.me/v1/recurring-contracts/{id}/toggle \
  --header 'X-API-Key: <sua_chave_api>' \
  --header 'Content-Type: application/json'
{
  "id": "a819c940-bf72-46a2-9659-192518e11a91",
  "active": false,
  "message": "Contrato pausado com sucesso"
}