Create credit | SchematicHQ

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.createBillingCredit({ 5 currency: "currency", 6 description: "description", 7 name: "name" 8 });

1 { 2 "data": { 3 "burn_strategy": "string", 4 "created_at": "2024-01-15T09:30:00Z", 5 "default_expiry_unit": "string", 6 "default_rollover_policy": "string", 7 "description": "string", 8 "id": "string", 9 "name": "string", 10 "updated_at": "2024-01-15T09:30:00Z", 11 "default_expiry_unit_count": 1, 12 "icon": "string", 13 "plural_name": "string", 14 "price": { 15 "currency": "string", 16 "external_price_id": "string", 17 "id": "string", 18 "interval": "string", 19 "price": 1, 20 "scheme": "string", 21 "price_decimal": "string" 22 }, 23 "product": { 24 "account_id": "string", 25 "created_at": "2024-01-15T09:30:00Z", 26 "environment_id": "string", 27 "external_id": "string", 28 "is_active": true, 29 "name": "string", 30 "price": 1.1, 31 "product_id": "string", 32 "quantity": 1.1, 33 "updated_at": "2024-01-15T09:30:00Z", 34 "price_decimal": "string", 35 "currency": "string" 36 }, 37 "singular_name": "string" 38 }, 39 "params": {} 40 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

currencystringRequired

descriptionstringRequired

namestringRequired

burn_strategyenum or nullOptional

Allowed values:

default_expiry_unitstring or nullOptional

default_expiry_unit_countinteger or nullOptional

default_rollover_policyenum or nullOptional

Allowed values:

iconstring or nullOptional

per_unit_priceinteger or nullOptional

per_unit_price_decimalstring or nullOptional

plural_namestring or nullOptional

singular_namestring or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors