Update a plan fee | Grant

import { AfternoonClient } from "grant-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.updateFee("cm5x9z8nv0000h85r7l9p2k1m", "cm5x9z8nv0005h85r7l9p2k6m", {});
}
main();

{
  "success": true,
  "fee": {
    "id": "cm5x9z8nv0005h85r7l9p2k6m",
    "plan_id": "cm5x9z8nv0000h85r7l9p2k1m",
    "product": {
      "id": "cm5x9z8nv0004h85r7l9p2k5m",
      "name": "Platform fee"
    },
    "price": {
      "id": "cm5x9z8nv0003h85r7l9p2k4m",
      "pricing_model": "flat",
      "amount": 5000,
      "denominator": 1,
      "billing_mode": "in_advance",
      "cadence": "monthly",
      "currency_code": "usd",
      "pricing_unit_id": null,
      "display_denominator": null,
      "cost_plus": {
        "markup_mode": "multiplier",
        "multiplier": 1.2,
        "target_margin": null
      }
    },
    "effective_from": null,
    "effective_to": null
  },
  "request_id": "req_abc123"
}

Updates a fee’s price or effective dates. The fee’s product cannot be changed; add a new fee instead. A new price can be created inline on the same product.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

feeIdstringRequiredformat: "cuid"

Request

This endpoint expects an object.

price_idstringOptionalformat: "cuid"

Existing price to switch the fee to. Must belong to the fee's product.

priceobjectOptional

Create a new price on the fee's product inline and switch the fee to it

effective_fromstring or nullOptionalformat: "^\d{4}-\d{2}-\d{2}(T.*)?$"

New effective start date; null clears it

effective_tostring or nullOptionalformat: "^\d{4}-\d{2}-\d{2}(T.*)?$"

New effective end date; null clears it

Response

Fee updated

successboolean

feeobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error