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 "auto_topup_enabled": true, 4 "created_at": "2024-01-15T09:30:00Z", 5 "credit_amount": 1, 6 "credit_id": "string", 7 "credit_name": "string", 8 "id": "string", 9 "plan_id": "string", 10 "plan_name": "string", 11 "reset_cadence": "string", 12 "reset_start": "string", 13 "updated_at": "2024-01-15T09:30:00Z", 14 "auto_topup_amount": 1, 15 "auto_topup_amount_type": "string", 16 "auto_topup_expiry_type": "string", 17 "auto_topup_expiry_unit": "string", 18 "auto_topup_expiry_unit_count": 1, 19 "auto_topup_threshold_percent": 1, 20 "credit_plural_name": "string", 21 "credit_singular_name": "string", 22 "expiry_type": "string", 23 "expiry_unit": "string", 24 "expiry_unit_count": 1, 25 "reset_type": "string" 26 }, 27 "params": {} 28 }

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:

apply_to_existingboolean or nullOptional

auto_topup_amountinteger or nullOptional

auto_topup_amount_typeenum or nullOptional

Allowed values:

auto_topup_enabledboolean or nullOptional

auto_topup_expiry_typeenum or nullOptional

Allowed values:

auto_topup_expiry_unitenum or nullOptional

Allowed values:

auto_topup_expiry_unit_countinteger or nullOptional

auto_topup_threshold_percentinteger or nullOptional

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