REST API · billing

POST /billing/addons/{addonKey}/downgrade

Schedule a tier downgrade for a non-stackable add-on (e.g. RPM tiers). The current tier stays active until the next renewal, at which point the lower tier is charged and activated. Body: `{targetAddonKey, project?}`. Returns `{addonKey, targetAddonKey, project, effectiveAt}`.

post_api_billing_addons_downgrade

Authentication

• Bearer

Parameters

Request body

application/json · required

{
    "targetAddonKey": "rpm_2000",
    "project": "support-desk"
}

Responses

200

The scheduled downgrade.

application/json

{
    "addonKey": "rpm_5000",
    "targetAddonKey": "rpm_2000",
    "project": "support-desk",
    "effectiveAt": "2026-02-14T09:00:00+00:00"
}

400

Unknown add-on, not a valid downgrade target, or none active.

application/json

{
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "description": "Machine-readable error code, e.g. \"not_found\", \"forbidden\", \"validation\".",
            "type": "string",
            "enum": [
                "bad_request",
                "unauthorized",
                "insufficient_credits",
                "forbidden",
                "web_only",
                "allowlist_widens",
                "not_found",
                "conflict",
                "draft_revision_conflict",
                "rollback_confirmation_conflict",
                "not_replayable",
                "targets_outside_allowlist",
                "gone",
                "deprecated_operation",
                "validation",
                "rate_limited",
                "payment_provider",
                "verification_unavailable",
                "analytics_unavailable",
                "credential_vault_unavailable",
                "notification_grants_unavailable"
            ]
        },
        "message": {
            "description": "Human-readable explanation of what went wrong. Absent on a field-level validation failure, where `fields` carries the detail instead.",
            "type": "string"
        },
        "object": {
            "description": "The resource the error concerns, when there is one.",
            "required": [
                "type",
                "id"
            ],
            "properties": {
                "type": {
                    "type": "string"
                },
                "id": {
                    "type": "string"
                }
            },
            "type": "object"
        },
        "action": {
            "description": "What to do next, naming the call or the panel page that does it. Absent when there is no corrective step.",
            "type": "string"
        },
        "fields": {
            "description": "Present when `error` is \"validation\" — one message per rejected field, keyed by the field name.",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        },
        "retry_after": {
            "description": "An RFC 3339 timestamp, the moment the request may be retried. Not every `rate_limited` refusal carries one.",
            "type": "string",
            "format": "date-time"
        }
    },
    "type": "object"
}