> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.trygrant.com/api-reference/grant-events-api/plans/create/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.trygrant.com/_mcp/server. # Create a plan POST https://api.trygrant.com/v1/plans Content-Type: application/json Creates a new plan for the authenticated company. Fees, credit grant policies, and pricing catalogs are attached with separate calls after creation. Reference: https://docs.trygrant.com/api-reference/grant-events-api/plans/create ## Authentication - `Authorization` header (bearer token, required) — API key obtained from the Grant dashboard ## Servers - `https://api.trygrant.com` (Production, default) - `http://localhost:8787` (Local development) ## Request ### Body (application/json) This endpoint expects a CreatePlanRequest. - `name` (string, required) — Display name of the plan - `plan_code` (string, optional) — Unique, human-readable plan identifier (lowercase letters, numbers, and underscores). Derived from the name when omitted. - `type` (enum, optional) — Billing model: classic usage-based (usage, default) or credit-based (credits) - Allowed values: `usage`, `credits` - `currency_code` (enum, optional) — Currency the plan bills in. Defaults to usd. - Allowed values: `usd`, `eur`, `gbp`, `cad`, `aud`, `jpy`, `chf`, `cny`, `sek`, `nzd`, `mxn`, `sgd`, `hkd`, `nok` - `invoicing_cadence` (enum, optional) — How often invoices are issued. Defaults to monthly. - Allowed values: `monthly`, `quarterly`, `yearly` - `initial_credit_quantity` (integer, optional, nullable) — Initial credit quantity granted on subscription start (credit-based plans only) ## Response ### 201 Plan created - `success` (boolean, required) - `plan` (Plan, required) - `request_id` (string, required) ## Errors ### 400 Bad Request Error Invalid request - `success` (boolean, required) - `error` (ErrorResponseError, required) - `request_id` (string, optional) — Request ID for tracing ### 401 Unauthorized Error Unauthorized - `success` (boolean, required) - `error` (ErrorResponseError, required) - `request_id` (string, optional) — Request ID for tracing ### 409 Conflict Error Conflict - `success` (boolean, required) - `error` (ErrorResponseError, required) - `request_id` (string, optional) — Request ID for tracing ### 500 Internal Server Error Internal server error - `success` (boolean, required) - `error` (ErrorResponseError, required) - `request_id` (string, optional) — Request ID for tracing ## Types ### Plan - `id` (string, required) - `name` (string, required) - `plan_code` (string, required, nullable) — Human-readable plan code - `type` (enum, required) - Allowed values: `usage`, `credits` - `currency_code` (string, required) — Currency code used for the plan - `invoicing_cadence` (enum, required) - Allowed values: `monthly`, `quarterly`, `yearly` - `initial_credit_quantity` (integer, required, nullable) — Initial credit quantity for credit-based plans - `created_at` (string, required) — ISO 8601 creation timestamp - `updated_at` (string, required) — ISO 8601 last-updated timestamp ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (any, optional) ## Examples **Request** ```json { "name": "Starter" } ``` **Response** ```json { "success": true, "plan": { "id": "cm5x9z8nv0000h85r7l9p2k1m", "name": "Starter", "plan_code": "starter_plan", "type": "usage", "currency_code": "usd", "invoicing_cadence": "monthly", "initial_credit_quantity": null, "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" }, "request_id": "req_abc123" } ``` **SDK Code** ```python import requests url = "https://api.trygrant.com/v1/plans" payload = { "name": "Starter" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.trygrant.com/v1/plans'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"Starter"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.trygrant.com/v1/plans" payload := strings.NewReader("{\n \"name\": \"Starter\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.trygrant.com/v1/plans") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Starter\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.trygrant.com/v1/plans") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Starter\"\n}") .asString(); ``` ```php request('POST', 'https://api.trygrant.com/v1/plans', [ 'body' => '{ "name": "Starter" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.trygrant.com/v1/plans"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Starter\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["name": "Starter"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.trygrant.com/v1/plans")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > API documentation for Grant — billing infrastructure for usage-based pricing