Create a plan | Grant | Documentation

Creates a new plan for the authenticated company. Fees, credit grant policies, and pricing catalogs are attached with separate calls after creation.

AuthorizationBearer

API key obtained from the Grant dashboard

This endpoint expects an object.

namestringRequired1-255 characters

Display name of the plan

plan_codestringOptionalformat: "^[a-z0-9]+(?:_[a-z0-9]+)*$"

Unique, human-readable plan identifier (lowercase letters, numbers, and underscores). Derived from the name when omitted.

typeenumOptional

Billing model: classic usage-based (usage, default) or credit-based (credits)

currency_codeenumOptional

Currency the plan bills in. Defaults to usd.

invoicing_cadenceenumOptional

How often invoices are issued. Defaults to monthly.

initial_credit_quantityinteger or nullOptional>=0

Initial credit quantity granted on subscription start (credit-based plans only)

Plan created

successboolean

planobject

request_idstring

400

Bad Request Error

401

Unauthorized Error

409

Conflict 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.create({
8	name: "Starter",
9	});
10	}
11	main();

1	{
2	"success": true,
3	"plan": {
4	"id": "cm5x9z8nv0000h85r7l9p2k1m",
5	"name": "Starter",
6	"plan_code": "starter_plan",
7	"type": "usage",
8	"currency_code": "usd",
9	"invoicing_cadence": "monthly",
10	"initial_credit_quantity": null,
11	"created_at": "2024-01-15T10:30:00.000Z",
12	"updated_at": "2024-01-15T10:30:00.000Z"
13	},
14	"request_id": "req_abc123"
15	}