Create credit bundle | SchematicHQ

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.createCreditBundle({ 5 bundleName: "bundle_name", 6 creditId: "credit_id", 7 currency: "currency", 8 pricePerUnit: 1 9 });

1 { 2 "data": { 3 "bundle_type": "string", 4 "created_at": "2024-01-15T09:30:00Z", 5 "credit_id": "string", 6 "credit_name": "string", 7 "expiry_type": "string", 8 "expiry_unit": "string", 9 "has_grants": true, 10 "id": "string", 11 "name": "string", 12 "status": "string", 13 "updated_at": "2024-01-15T09:30:00Z", 14 "billing_invoice_id": "string", 15 "credit_description": "string", 16 "credit_icon": "string", 17 "expiry_unit_count": 1, 18 "plural_name": "string", 19 "price": { 20 "currency": "string", 21 "external_price_id": "string", 22 "id": "string", 23 "interval": "string", 24 "price": 1, 25 "scheme": "string", 26 "price_decimal": "string" 27 }, 28 "quantity": 1, 29 "singular_name": "string", 30 "unit_price": { 31 "currency": "string", 32 "external_price_id": "string", 33 "id": "string", 34 "interval": "string", 35 "price": 1, 36 "scheme": "string", 37 "price_decimal": "string" 38 } 39 }, 40 "params": {} 41 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

bundle_namestringRequired

credit_idstringRequired

currencystringRequired

price_per_unitintegerRequired

bundle_typeenum or nullOptional

Allowed values:

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countinteger or nullOptional

price_per_unit_decimalstring or nullOptional

quantityinteger or nullOptional

statusenum or nullOptional

Allowed values:

Response

Created

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors