Add a fee to a plan

POST

/v1/plans/:id/fees

POST

/v1/plans/:id/fees

1 import { AfternoonClient } from "grant-sdk";
2 
3 async function main() {
4     const client = new AfternoonClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.plans.createFee("cm5x9z8nv0000h85r7l9p2k1m", {});
8 }
9 main();

1 {
2   "success": true,
3   "fee": {
4     "id": "cm5x9z8nv0005h85r7l9p2k6m",
5     "plan_id": "cm5x9z8nv0000h85r7l9p2k1m",
6     "product": {
7       "id": "cm5x9z8nv0004h85r7l9p2k5m",
8       "name": "Platform fee"
9     },
10     "price": {
11       "id": "cm5x9z8nv0003h85r7l9p2k4m",
12       "pricing_model": "flat",
13       "amount": 5000,
14       "denominator": 1,
15       "billing_mode": "in_advance",
16       "cadence": "monthly",
17       "currency_code": "usd",
18       "pricing_unit_id": null,
19       "display_denominator": null,
20       "cost_plus": {
21         "markup_mode": "multiplier",
22         "multiplier": 1.2,
23         "target_margin": null
24       }
25     },
26     "effective_from": null,
27     "effective_to": null
28   },
29   "request_id": "req_abc123"
30 }

Attaches a fixed (flat) or usage-based (per_unit / cost_plus) fee to a plan. The product and price can be referenced by ID or created inline in the same call. Multiple versions of a fee for the same product are allowed as long as their effective date ranges do not overlap.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

product_idstringOptionalformat: "cuid"

Existing product to attach the fee to

productobjectOptional

Create a new product inline instead of using product_id

price_idstringOptionalformat: "cuid"

Existing price to bill. The fee is attached to the price’s product, so product_id/product must be omitted.

priceobjectOptional

Create a new price inline instead of using price_id

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

Date the fee becomes effective (YYYY-MM-DD in the company’s timezone, or ISO datetime). Null or omitted = effective immediately.

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

Date the fee stops being effective. Null or omitted = open-ended.

Response

Fee created

successboolean

feeobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error