Zero out credit grant

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.credits.zeroOutGrant("grant_id");

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": "billing_credit_auto_topup", 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": "day", 24 "price": 1, 25 "scheme": "per_unit", 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": "expired" 31 }, 32 "params": {} 33 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

grant_idstringRequired

grant_id

Request

This endpoint expects an object.

reasonenum or nullOptional

Allowed values:

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Request

Response

Errors