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: 5000,
        creditId: "crd_8f3b2a1d",
        planId: "pln_4a7c9e2f",
        resetCadence: "monthly",
        resetStart: "first_of_month",
    });
}
main();

{
  "data": {
    "auto_topup_enabled": true,
    "auto_topup_self_service": true,
    "created_at": "2024-01-15T09:30:00Z",
    "credit_amount": 5000,
    "credit_id": "crd_8f3b2a1d",
    "id": "grant_123abc",
    "plan_id": "pln_4a7c9e2f",
    "rollover_percentage": 50,
    "updated_at": "2024-01-15T09:30:00Z",
    "credit_name": "API Call Credit",
    "plan_name": "Pro Plan",
    "auto_topup_amount": 1000,
    "auto_topup_amount_type": "credit",
    "auto_topup_expiry_type": "duration",
    "auto_topup_expiry_unit": "billing_periods",
    "auto_topup_expiry_unit_count": 2,
    "auto_topup_threshold_credits": 200,
    "auto_topup_threshold_percent": 20,
    "credit": {
      "burn_strategy": "expiration_priority",
      "cost_editable": true,
      "created_at": "2023-11-01T08:00:00Z",
      "currency_prices": [
        {
          "currency": "USD",
          "price": {
            "currency": "USD",
            "external_price_id": "ext_prc_12345",
            "id": "prc_67890",
            "interval": "month",
            "interval_count": 1,
            "price": 1000,
            "provider_type": "stripe",
            "scheme": "per_unit",
            "nickname": "Standard Credit Price",
            "price_decimal": "10.00"
          }
        }
      ],
      "default_expiry_unit": "billing_periods",
      "default_rollover_policy": "rollover",
      "description": "Standard usage credits for API calls",
      "id": "crd_8f3b2a1d",
      "name": "API Call Credit",
      "updated_at": "2024-01-15T09:30:00Z",
      "default_expiry_unit_count": 3,
      "icon": "https://example.com/icons/credit.png",
      "plural_name": "API Call Credits",
      "price": {
        "currency": "USD",
        "external_price_id": "ext_prc_12345",
        "id": "prc_67890",
        "interval": "month",
        "interval_count": 1,
        "price": 1000,
        "provider_type": "stripe",
        "scheme": "per_unit",
        "nickname": "Standard Credit Price",
        "price_decimal": "10.00"
      },
      "product": {
        "account_id": "acc_00112233",
        "created_at": "2023-10-01T12:00:00Z",
        "environment_id": "env_prod_01",
        "external_id": "prod_ext_98765",
        "is_active": true,
        "name": "API Credit Product",
        "price": 10,
        "product_id": "prod_445566",
        "provider_type": "stripe",
        "quantity": 1000,
        "updated_at": "2024-01-10T15:00:00Z",
        "price_decimal": "10.00",
        "currency": "USD"
      },
      "singular_name": "API Call Credit"
    },
    "expiry_type": "duration",
    "expiry_unit": "billing_periods",
    "expiry_unit_count": 3,
    "plan": {
      "id": "pln_4a7c9e2f",
      "name": "Pro Plan",
      "description": "Pro Plan with extended API limits",
      "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

reset_startenumRequired

apply_to_existingboolean or nullOptional

auto_topup_amountlong or nullOptional>=1

auto_topup_amount_typeenum or nullOptional

auto_topup_enabledboolean or nullOptional

auto_topup_expiry_typeenum or nullOptional

auto_topup_expiry_unitenum or nullOptional

auto_topup_expiry_unit_countlong or nullOptional>=1

auto_topup_self_serviceboolean or nullOptional

auto_topup_threshold_creditslong or nullOptional>=0

auto_topup_threshold_percentlong or nullOptional1-100

expiry_typeenum or nullOptional

expiry_unitenum or nullOptional

expiry_unit_countlong or nullOptional>=1

plan_version_idstring or nullOptional

reset_typeenum or nullOptional

rollover_percentagelong or nullOptional0-100

Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. Defaults to 0.

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