curl --request POST 'https://api.integrateledger.com/v1/billing/downgrade' \
  -H "Authorization: Bearer $LEDGER_API_KEY" \
  -H 'Idempotency-Key: downgrade_123' \
  -H 'Content-Type: application/json' \
  --data '{"customerId":"user_123","planId":"starter","timing":"period_end"}'

import ledger from "integrateledger";

const client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? "" });
await client.downgradePaidPlan({ idempotencyKey: "downgrade_123", body: { customerId: "user_123", planId: "starter", timing: "period_end" } });

import os
from integrateledger import ledger

client = ledger(api_key=os.environ["LEDGER_API_KEY"])
client.downgrade_paid_plan(customer_id="user_123", plan_id="starter", timing="period_end", idempotency_key="downgrade_123")

{
  "downgradeId": 123,
  "status": "pending",
  "fromPlanId": "<string>",
  "planId": "<string>",
  "timing": "period_end",
  "refund": "none",
  "oldPlanCredits": "keep",
  "overageOnPlanChange": "carry_to_renewal",
  "effectiveAt": "2023-11-07T05:31:56Z",
  "refundAmountCents": 123,
  "creditNoteId": "<string>"
}

{
  "error": "<string>",
  "downgradeId": 123
}

{
  "error": "<string>",
  "downgradeId": 123
}

{
  "error": "<string>",
  "downgradeId": 123
}

{
  "error": "<string>",
  "downgradeId": 123
}

{
  "error": "payload_too_large"
}

{
  "error": "rate_limited"
}

{
  "error": "internal_error",
  "request_id": "<string>"
}

{
  "error": "<string>",
  "downgradeId": 123
}

{
  "error": "<string>",
  "downgradeId": 123
}