List plan fees

GET

/v1/plans/:id/fees

GET

/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.listFees("cm5x9z8nv0000h85r7l9p2k1m", {});
8 }
9 main();

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

Returns the fixed and usage-based fees attached to a plan. Pass active=true to only include fees effective right now.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

Query parameters

activeenumOptional

When true, only fees effective at the current time

Allowed values:

Response

Plan fees

successboolean

feeslist of objects

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error