Grant credits to company

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.grantBillingCreditsToCompany({
        companyId: "comp_987654321",
        creditId: "cred_123456789",
        quantity: 10,
        reason: "adjustment",
    });
}
main();

{
  "data": {
    "company_id": "comp_987654321",
    "company_name": "Acme Corporation",
    "created_at": "2024-01-15T09:30:00Z",
    "credit_id": "cred_123456789",
    "credit_name": "Standard Usage Credit",
    "grant_reason": "adjustment",
    "id": "grant_abc123xyz",
    "quantity": 10,
    "quantity_remaining": 7.5,
    "quantity_used": 2.5,
    "renewal_enabled": true,
    "source_label": "admin_adjustment",
    "updated_at": "2024-01-15T09:30:00Z",
    "credit_icon": "https://cdn.schematichq.com/icons/credit.svg",
    "currency": "USD",
    "expires_at": "2024-12-31T23:59:59Z",
    "plan_id": "plan_premium_001",
    "plan_name": "Premium Plan",
    "price": {
      "currency": "USD",
      "external_price_id": "price_789xyz",
      "id": "price_001",
      "interval": "month",
      "price": 5000,
      "provider_type": "schematic",
      "scheme": "per_unit",
      "price_decimal": "50.00"
    },
    "renewal_period": "monthly",
    "transfers": [
      {
        "amount": 10,
        "created_at": "2024-01-15T09:30:00Z",
        "direction": "inbound",
        "id": "transfer_001",
        "reason": "manual_adjustment",
        "related_grant_id": "grant_abc123xyz"
      }
    ],
    "valid_from": "2024-01-15T09:30:00Z",
    "zeroed_out_date": "2024-12-31T23:59:59Z",
    "zeroed_out_reason": "expired"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

company_idstringRequired

credit_idstringRequired

quantitylongRequired>=1

reasonenumRequired

Allowed values:

billing_periods_countlong or nullOptional>=1

currencystring or nullOptional<=3 characters

expires_atdatetime or nullOptional

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countlong or nullOptional>=1

renewal_enabledboolean or nullOptional

renewal_periodenum or nullOptional

Allowed values:

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error