Update credit | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
await client.credits.updateBillingCredit("credit_id", {
    description: "description",
    name: "name"
});

{
  "data": {
    "burn_strategy": "expiration_priority",
    "created_at": "2024-01-15T09:30:00Z",
    "default_expiry_unit": "billing_periods",
    "default_rollover_policy": "expire",
    "description": "Credit applied for premium API usage with expiration after 3 billing periods",
    "id": "crd_1234567890abcdef",
    "name": "Premium API Credit",
    "updated_at": "2024-01-15T09:30:00Z",
    "default_expiry_unit_count": 3,
    "icon": "star",
    "plural_name": "Premium API Credits",
    "price": {
      "currency": "USD",
      "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
      "id": "price_9876543210fedcba",
      "interval": "month",
      "price": 5000,
      "provider_type": "schematic",
      "scheme": "per_unit",
      "price_decimal": "50.00"
    },
    "product": {
      "account_id": "acc_0011223344556677",
      "created_at": "2023-12-01T08:00:00Z",
      "environment_id": "env_prod_01",
      "external_id": "prod_premium_api_01",
      "is_active": true,
      "name": "Premium API Access",
      "price": 49.99,
      "product_id": "prod_abcdef1234567890",
      "provider_type": "schematic",
      "quantity": 1,
      "updated_at": "2024-01-10T12:00:00Z",
      "price_decimal": "49.99",
      "currency": "USD"
    },
    "singular_name": "Premium API Credit"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

credit_idstringRequired

credit_id

Request

This endpoint expects an object.

descriptionstringRequired<=1024 characters

namestringRequired<=255 characters

burn_strategyenum or nullOptional

Allowed values:

default_expiry_unitenum or nullOptional

Allowed values:

default_expiry_unit_countinteger or nullOptional>=1

default_rollover_policyenum or nullOptional

Allowed values:

iconstring or nullOptional<=64 characters

per_unit_priceinteger or nullOptional>=1

per_unit_price_decimalstring or nullOptional

plural_namestring or nullOptional<=512 characters

singular_namestring or nullOptional<=512 characters

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Request

Response

Errors