List credit grant policies

GET

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

GET

/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.listCreditGrantPolicies("cm5x9z8nv0000h85r7l9p2k1m");
8 }
9 main();

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

Returns the automated credit grant policies configured on a plan.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Path parameters

idstringRequiredformat: "cuid"

Response

Credit grant policies

successboolean

credit_grant_policieslist of objects

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error