Create plan credit grant

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.createBillingPlanCreditGrant({
        creditAmount: 500,
        creditId: "crd_8f3b2a1d",
        planId: "pln_4d2c9e7f",
        resetCadence: "monthly",
        resetStart: "first_of_month",
    });
}
main();

{
  "data": {
    "auto_topup_enabled": true,
    "created_at": "2024-01-15T09:30:00Z",
    "credit_amount": 500,
    "credit_id": "crd_8f3b2a1d",
    "id": "grant_9a7b6c5d",
    "plan_id": "pln_4d2c9e7f",
    "updated_at": "2024-01-15T09:30:00Z",
    "credit_name": "API Call Credit",
    "plan_name": "Pro Plan",
    "auto_topup_amount": 100,
    "auto_topup_amount_type": "credit",
    "auto_topup_expiry_type": "duration",
    "auto_topup_expiry_unit": "billing_periods",
    "auto_topup_expiry_unit_count": 3,
    "auto_topup_threshold_credits": 50,
    "auto_topup_threshold_percent": 20,
    "credit": {
      "burn_strategy": "expiration_priority",
      "cost_editable": true,
      "created_at": "2023-12-01T08:00:00Z",
      "currency_prices": [
        {
          "currency": "USD",
          "price": {
            "currency": "USD",
            "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
            "id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
            "interval": "month",
            "price": 1000,
            "provider_type": "stripe",
            "scheme": "per_unit",
            "price_decimal": "10.00"
          }
        }
      ],
      "default_expiry_unit": "billing_periods",
      "default_rollover_policy": "rollover",
      "description": "Standard API call credits",
      "id": "crd_8f3b2a1d",
      "name": "API Call Credit",
      "updated_at": "2024-01-10T12:00:00Z",
      "default_expiry_unit_count": 12,
      "icon": "https://example.com/icons/api-credit.png",
      "plural_name": "API Call Credits",
      "price": {
        "currency": "USD",
        "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
        "id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
        "interval": "month",
        "price": 1000,
        "provider_type": "stripe",
        "scheme": "per_unit",
        "price_decimal": "10.00"
      },
      "product": {
        "account_id": "acc_123456789",
        "created_at": "2023-11-15T10:00:00Z",
        "environment_id": "env_prod_001",
        "external_id": "prod_abc123",
        "is_active": true,
        "name": "API Credit Pack",
        "price": 10,
        "product_id": "prod_abc123",
        "provider_type": "stripe",
        "quantity": 1,
        "updated_at": "2024-01-10T12:00:00Z",
        "price_decimal": "10.00",
        "currency": "USD"
      },
      "singular_name": "API Call Credit"
    },
    "expiry_type": "duration",
    "expiry_unit": "billing_periods",
    "expiry_unit_count": 12,
    "plan": {
      "id": "pln_4d2c9e7f",
      "name": "Pro Plan",
      "description": "Pro Plan with extended API access",
      "image_url": "https://example.com/images/pro-plan.png"
    },
    "plan_version_id": "v2.1.0",
    "reset_cadence": "monthly",
    "reset_start": "first_of_month",
    "reset_type": "plan_period",
    "credit_plural_name": "API Call Credits",
    "credit_singular_name": "API Call Credit"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

credit_amountlongRequired0-9999999999

credit_idstringRequired

plan_idstringRequired

reset_cadenceenumRequired

Allowed values:

reset_startenumRequired

Allowed values:

apply_to_existingboolean or nullOptional

auto_topup_amountlong or nullOptional>=1

auto_topup_amount_typeenum or nullOptional

Allowed values:

auto_topup_enabledboolean or nullOptional

auto_topup_expiry_typeenum or nullOptional

Allowed values:

auto_topup_expiry_unitenum or nullOptional

Allowed values:

auto_topup_expiry_unit_countlong or nullOptional>=1

auto_topup_threshold_creditslong or nullOptional>=0

auto_topup_threshold_percentlong or nullOptional1-100

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countlong or nullOptional>=1

plan_version_idstring or nullOptional

reset_typeenum 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