Toggle opt-in del cliente para permitir overage de cuota mensual
POST
/v1/client/keys/{id}/overage
const url = 'https://api.mailerdash.com/v1/client/keys/example/overage';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"enabled":true,"password":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.mailerdash.com/v1/client/keys/example/overage \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "enabled": true, "password": "example" }'Activa o desactiva overage para la key vinculada al usuario. Cuando overage está activo y se llega a monthly_quota, los siguientes envíos se cobran al precio overage_per_1k_usd_cents del package en lugar de bloquearse (hasta overage_max_pct% adicional). Opt-in explícito protege al cliente de cobros sorpresa. Sólo confirmación: desde 2026-09-09 no pide contraseña, pero el cambio queda en audit_events y se avisa por correo a la cuenta (y al contacto alterno, si hay).
Authorizations
Sección titulada «Authorizations »Parameters
Sección titulada « Parameters »Path Parameters
Sección titulada «Path Parameters » id
required
string
Request Body required
Sección titulada «Request Body required » Media type application/json
object
enabled
required
True para activar overage, false para desactivar
boolean
password
Ya no se pide ni se valida (2026-09-09). Se sigue aceptando para no romper a quien lo mandaba; se ignora.
string
Example generated
{ "enabled": true, "password": "example"}Responses
Sección titulada « Responses »Toggle aplicado
Media type application/json
object
key_id
string
overage_enabled
boolean
Example generated
{ "key_id": "example", "overage_enabled": true}Enabled inválido o package no ofrece overage
Password incorrecto
Key no vinculada al usuario
Key no encontrada