Create plan credit grant

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.createBillingPlanCreditGrant({ 5 creditAmount: 1, 6 creditId: "credit_id", 7 planId: "plan_id", 8 resetCadence: "monthly", 9 resetStart: "billing_period" 10 });

1 { 2 "data": { 3 "created_at": "2024-01-15T09:30:00Z", 4 "credit_amount": 1, 5 "credit_id": "string", 6 "credit_name": "string", 7 "id": "string", 8 "plan_id": "string", 9 "plan_name": "string", 10 "reset_cadence": "string", 11 "reset_start": "string", 12 "updated_at": "2024-01-15T09:30:00Z", 13 "credit_plural_name": "string", 14 "credit_singular_name": "string", 15 "expiry_type": "string", 16 "expiry_unit": "string", 17 "expiry_unit_count": 1, 18 "reset_type": "string" 19 }, 20 "params": {} 21 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

credit_amountintegerRequired

credit_idstringRequired

plan_idstringRequired

reset_cadenceenumRequired

Allowed values:

reset_startenumRequired

Allowed values:

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countinteger or nullOptional

reset_typeenum or nullOptional

Allowed values:

Response

Created

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors