> 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/plan-credit-grant-policies/create-credit-grant-policy/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.trygrant.com/_mcp/server. # Create a credit grant policy POST https://api.trygrant.com/v1/plans/{id}/credit-grant-policies Content-Type: application/json Adds an automated credit grant policy to a plan. Subscriptions on the plan receive the grant on the configured cadence, denominated in a currency or a custom pricing unit, optionally expiring after an interval. Reference: https://docs.trygrant.com/api-reference/grant-events-api/plan-credit-grant-policies/create-credit-grant-policy ## 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 ### Path parameters - `id` (string, required) ### Body (application/json) This endpoint expects a CreateCreditGrantPolicyRequest. - `account_type` (enum, required) — Whether credits are granted in a custom pricing unit or in currency - Allowed values: `pricing_unit`, `currency` - `amount` (integer, required) — Grant amount per cadence: minor currency units (e.g. cents) for currency grants, whole units for pricing_unit grants - `cadence` (enum, required) — How often the grant recurs; one_off_subscription_start grants once when a subscription starts - Allowed values: `daily`, `weekly`, `monthly`, `quarterly`, `yearly`, `one_off_subscription_start` - `pricing_unit_id` (string, optional) — Pricing unit to grant (required when account_type is pricing_unit) - `currency_code` (enum, optional) — Currency to grant (required when account_type is currency) - Allowed values: `usd`, `eur`, `gbp`, `cad`, `aud`, `jpy`, `chf`, `cny`, `sek`, `nzd`, `mxn`, `sgd`, `hkd`, `nok` - `expiration_interval_count` (integer, optional, nullable) — How many expiration_interval_units granted credits live before expiring. Omit both fields for non-expiring credits. - `expiration_interval_unit` (enum, optional) — Unit for expiration_interval_count - Allowed values: `day`, `week`, `month`, `year` - `effective_from` (datetime, optional, nullable) — ISO 8601 timestamp the policy becomes effective - `effective_to` (datetime, optional, nullable) — ISO 8601 timestamp the policy stops being effective ## Response ### 201 Credit grant policy created - `success` (boolean, required) - `credit_grant_policy` (CreditGrantPolicy, 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 ### 404 Not Found Error Plan not found - `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 ### CreditGrantPolicy - `id` (string, required) - `plan_id` (string, required) - `account_type` (enum, required) - Allowed values: `pricing_unit`, `currency` - `pricing_unit_id` (string, required, nullable) - `currency_code` (string, required, nullable) - `amount` (integer, required) — Grant amount per cadence: minor currency units for currency grants, whole units for pricing_unit grants - `cadence` (enum, required) - Allowed values: `daily`, `weekly`, `monthly`, `quarterly`, `yearly`, `one_off_subscription_start` - `expiration_interval_count` (integer, required, nullable) - `expiration_interval_unit` (enum, required) - Allowed values: `day`, `week`, `month`, `year` - `effective_from` (string, required, nullable) - `effective_to` (string, required, nullable) - `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 { "account_type": "currency", "amount": 10000, "cadence": "monthly" } ``` **Response** ```json { "success": true, "credit_grant_policy": { "id": "cm5x9z8nv0010h85r7l9p2l1m", "plan_id": "cm5x9z8nv0000h85r7l9p2k1m", "account_type": "currency", "pricing_unit_id": null, "currency_code": "usd", "amount": 10000, "cadence": "monthly", "expiration_interval_count": null, "expiration_interval_unit": "day", "effective_from": null, "effective_to": 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/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies" payload = { "account_type": "currency", "amount": 10000, "cadence": "monthly" } 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/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"account_type":"currency","amount":10000,"cadence":"monthly"}' }; 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/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies" payload := strings.NewReader("{\n \"account_type\": \"currency\",\n \"amount\": 10000,\n \"cadence\": \"monthly\"\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/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies") 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 \"account_type\": \"currency\",\n \"amount\": 10000,\n \"cadence\": \"monthly\"\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/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"account_type\": \"currency\",\n \"amount\": 10000,\n \"cadence\": \"monthly\"\n}") .asString(); ``` ```php request('POST', 'https://api.trygrant.com/v1/plans/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies', [ 'body' => '{ "account_type": "currency", "amount": 10000, "cadence": "monthly" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.trygrant.com/v1/plans/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"account_type\": \"currency\",\n \"amount\": 10000,\n \"cadence\": \"monthly\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "account_type": "currency", "amount": 10000, "cadence": "monthly" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.trygrant.com/v1/plans/cm5x9z8nv0000h85r7l9p2k1m/credit-grant-policies")! 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