Zero out credit grant

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.zeroOutGrant("grant_id", {});
}
main();

{
  "data": {
    "company_id": "c1234567890",
    "company_name": "Acme Corporation",
    "created_at": "2024-01-15T09:30:00Z",
    "credit_id": "crd_987654321",
    "credit_name": "Monthly Usage Credit",
    "grant_reason": "adjustment",
    "id": "grant_123abc456def",
    "quantity": 100,
    "quantity_remaining": 25.5,
    "quantity_used": 74.5,
    "renewal_enabled": true,
    "source_label": "Rollover from December",
    "updated_at": "2024-01-15T09:30:00Z",
    "credit_icon": "https://cdn.schematichq.com/icons/credit.png",
    "currency": "USD",
    "expires_at": "2024-12-31T23:59:59Z",
    "plan_id": "plan_gold_001",
    "plan_name": "Gold Subscription Plan",
    "price": {
      "currency": "USD",
      "external_price_id": "price_789xyz",
      "id": "price_001",
      "interval": "month",
      "interval_count": 1,
      "price": 4999,
      "provider_type": "stripe",
      "scheme": "per_unit",
      "nickname": "Gold Monthly Price",
      "price_decimal": "49.99"
    },
    "renewal_period": "monthly",
    "reserved": 10,
    "settled": 65,
    "source_grant_id": "grant_abc123xyz789",
    "transfers": [
      {
        "amount": 10,
        "created_at": "2024-01-10T12:00:00Z",
        "direction": "inbound",
        "id": "transfer_001",
        "reason": "rollover",
        "related_grant_id": "grant_abc123xyz789"
      }
    ],
    "valid_from": "2024-01-01T00:00:00Z",
    "zeroed_out_date": "2024-01-15T09:30:00Z",
    "zeroed_out_reason": "expired"
  },
  "params": {}
}

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

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error