Grant credits to company

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.grantBillingCreditsToCompany({ 5 companyId: "company_id", 6 creditId: "credit_id", 7 quantity: 1, 8 reason: "reason" 9 });

1 { 2 "data": { 3 "company_id": "string", 4 "company_name": "string", 5 "created_at": "2024-01-15T09:30:00Z", 6 "credit_id": "string", 7 "credit_name": "string", 8 "grant_reason": "string", 9 "id": "string", 10 "quantity": 1, 11 "quantity_remaining": 1.1, 12 "quantity_used": 1.1, 13 "source_label": "string", 14 "updated_at": "2024-01-15T09:30:00Z", 15 "credit_icon": "string", 16 "expires_at": "2024-01-15T09:30:00Z", 17 "plan_id": "string", 18 "plan_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 "valid_from": "2024-01-15T09:30:00Z", 29 "zeroed_out_date": "2024-01-15T09:30:00Z", 30 "zeroed_out_reason": "string" 31 }, 32 "params": {} 33 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

company_idstringRequired

credit_idstringRequired

quantityintegerRequired

reasonstringRequired

billing_periods_countinteger or nullOptional

expires_atstring or nullOptionalformat: "date-time"

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countinteger or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors