Update a plan | Grant | Documentation

Updates an existing plan. Only provided fields are changed. Once a plan has subscriptions, type, currency_code, and invoicing_cadence become immutable; name, plan_code, and initial_credit_quantity stay editable.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

namestringOptional1-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)

Response

Plan updated

successboolean

planobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found 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.update("cm5x9z8nv0000h85r7l9p2k1m", {});
8	}
9	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	}