Create credit | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.createBillingCredit({
        currency: "USD",
        description: "Credit for premium API usage",
        name: "Premium API Credit",
    });
}
main();

{
  "data": {
    "burn_strategy": "expiration_priority",
    "cost_editable": true,
    "created_at": "2024-01-15T09:30:00Z",
    "currency_prices": [
      {
        "currency": "USD",
        "price": {
          "currency": "USD",
          "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
          "id": "price_1234567890abcdef",
          "interval": "day",
          "price": 1000,
          "provider_type": "schematic",
          "scheme": "per_unit",
          "price_decimal": "10.00"
        }
      }
    ],
    "default_expiry_unit": "billing_periods",
    "default_rollover_policy": "expire",
    "description": "Credit for premium API usage",
    "id": "credit_9876543210abcdef",
    "name": "Premium API Credit",
    "updated_at": "2024-01-15T09:30:00Z",
    "default_expiry_unit_count": 1,
    "icon": "star",
    "plural_name": "Premium API Credits",
    "price": {
      "currency": "USD",
      "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
      "id": "price_1234567890abcdef",
      "interval": "day",
      "price": 1000,
      "provider_type": "schematic",
      "scheme": "per_unit",
      "price_decimal": "10.00"
    },
    "product": {
      "account_id": "acct_001122334455",
      "created_at": "2024-01-15T09:30:00Z",
      "environment_id": "env_prod_01",
      "external_id": "prod_ext_001",
      "is_active": true,
      "name": "Premium API Access",
      "price": 10,
      "product_id": "prod_abcdef123456",
      "provider_type": "schematic",
      "quantity": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "price_decimal": "10.00",
      "currency": "USD"
    },
    "singular_name": "Premium API Credit"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

currencystringRequired

descriptionstringRequired<=1024 characters

namestringRequired<=255 characters

burn_strategyenum or nullOptional

Allowed values:

currency_priceslist of objects or nullOptional

default_expiry_unitenum or nullOptional

Allowed values:

default_expiry_unit_countlong or nullOptional>=1

default_rollover_policyenum or nullOptional

Allowed values:

iconstring or nullOptional<=64 characters

per_unit_pricelong or nullOptional

per_unit_price_decimalstring or nullOptional

plural_namestring or nullOptional<=512 characters

singular_namestring or nullOptional<=512 characters

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