List plans

GET

/v1/plans

Returns a paginated list of plans for the authenticated company.

AuthorizationBearer

API key obtained from the Grant dashboard

limitstringOptionalDefaults to 50

cursorstringOptional

Plans list

successboolean

planslist of objects

paginationobject

request_idstring

401

Unauthorized Error

500

Internal Server Error

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.list({});
8	}
9	main();

1	{
2	"success": true,
3	"plans": [
4	{
5	"id": "cm5x9z8nv0000h85r7l9p2k1m",
6	"name": "Starter",
7	"plan_code": "starter_plan",
8	"type": "usage",
9	"currency_code": "usd",
10	"invoicing_cadence": "monthly",
11	"initial_credit_quantity": null,
12	"created_at": "2024-01-15T10:30:00.000Z",
13	"updated_at": "2024-01-15T10:30:00.000Z"
14	}
15	],
16	"pagination": {
17	"has_more": true,
18	"next_cursor": "cm5x9z8nv0000h85r7l9p2k1m"
19	},
20	"request_id": "req_abc123"
21	}