Create a credit grant policy

POST

/v1/plans/:id/credit-grant-policies

POST

/v1/plans/:id/credit-grant-policies

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.createCreditGrantPolicy("cm5x9z8nv0000h85r7l9p2k1m", {
8         accountType: "currency",
9         amount: 10000,
10         cadence: "monthly",
11     });
12 }
13 main();

1 {
2   "success": true,
3   "credit_grant_policy": {
4     "id": "cm5x9z8nv0010h85r7l9p2l1m",
5     "plan_id": "cm5x9z8nv0000h85r7l9p2k1m",
6     "account_type": "currency",
7     "pricing_unit_id": null,
8     "currency_code": "usd",
9     "amount": 10000,
10     "cadence": "monthly",
11     "expiration_interval_count": null,
12     "expiration_interval_unit": "day",
13     "effective_from": null,
14     "effective_to": null,
15     "created_at": "2024-01-15T10:30:00.000Z",
16     "updated_at": "2024-01-15T10:30:00.000Z"
17   },
18   "request_id": "req_abc123"
19 }

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.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

account_typeenumRequired

Whether credits are granted in a custom pricing unit or in currency

amountintegerRequired

Grant amount per cadence: minor currency units (e.g. cents) for currency grants, whole units for pricing_unit grants

cadenceenumRequired

How often the grant recurs; one_off_subscription_start grants once when a subscription starts

pricing_unit_idstringOptional

Pricing unit to grant (required when account_type is pricing_unit)

currency_codeenumOptional

Currency to grant (required when account_type is currency)

expiration_interval_countinteger or nullOptional

How many expiration_interval_units granted credits live before expiring. Omit both fields for non-expiring credits.

expiration_interval_unitenumOptional

Unit for expiration_interval_count

effective_fromdatetime or nullOptional

ISO 8601 timestamp the policy becomes effective

effective_todatetime or nullOptional

ISO 8601 timestamp the policy stops being effective

Response

Credit grant policy created

successboolean

credit_grant_policyobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error