Zero out credit grant

PUT

https://api.schematichq.com/billing/credits/grants/:grant_id/zero-out

PUT

/billing/credits/grants/:grant_id/zero-out

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.credits.zeroOutGrant("grant_id", {});
8 }
9 main();

1 {
2   "data": {
3     "company_id": "c1234567890",
4     "company_name": "Acme Corporation",
5     "created_at": "2024-01-15T09:30:00Z",
6     "credit_id": "crd_987654321",
7     "credit_name": "Monthly Usage Credit",
8     "grant_reason": "adjustment",
9     "id": "grant_abc123xyz",
10     "quantity": 100,
11     "quantity_remaining": 25.5,
12     "quantity_used": 74.5,
13     "renewal_enabled": true,
14     "source_label": "auto_topup",
15     "updated_at": "2024-01-15T09:30:00Z",
16     "credit_icon": "https://cdn.schematichq.com/icons/credit.svg",
17     "currency": "USD",
18     "expires_at": "2024-12-31T23:59:59Z",
19     "plan_id": "plan_premium_001",
20     "plan_name": "Premium Plan",
21     "price": {
22       "currency": "USD",
23       "external_price_id": "price_001",
24       "id": "price_abc123",
25       "interval": "month",
26       "price": 2999,
27       "provider_type": "schematic",
28       "scheme": "per_unit",
29       "price_decimal": "29.99"
30     },
31     "renewal_period": "monthly",
32     "transfers": [
33       {
34         "amount": 10,
35         "created_at": "2024-01-10T12:00:00Z",
36         "direction": "inbound",
37         "id": "transfer_001",
38         "reason": "topup",
39         "related_grant_id": "grant_abc123xyz"
40       }
41     ],
42     "valid_from": "2024-01-01T00:00:00Z",
43     "zeroed_out_date": "2024-01-15T09:30:00Z",
44     "zeroed_out_reason": "expired"
45   },
46   "params": {}
47 }

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error