Create credit bundle | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.credits.createCreditBundle({
        bundleName: "Premium Data Credits",
        creditId: "crd_9f8b7a6c5d4e3f2a1b0c",
        currency: "USD",
        pricePerUnit: 1500,
    });
}
main();

{
  "data": {
    "bundle_type": "fixed",
    "created_at": "2024-01-15T09:30:00Z",
    "credit_id": "crd_9f8b7a6c5d4e3f2a1b0c",
    "credit_name": "Premium Data Credit",
    "currency_prices": [
      {
        "currency": "USD",
        "price": {
          "currency": "USD",
          "external_price_id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
          "id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
          "interval": "day",
          "price": 1500,
          "provider_type": "schematic",
          "scheme": "per_unit",
          "price_decimal": "15.00"
        }
      }
    ],
    "expiry_type": "duration",
    "expiry_unit": "billing_periods",
    "has_grants": true,
    "id": "bundle_4f3e2d1c0b9a8e7f6d5c",
    "name": "Premium Data Credits",
    "status": "active",
    "updated_at": "2024-01-15T09:30:00Z",
    "billing_invoice_id": "inv_1234567890abcdef",
    "credit_description": "Access to premium data processing credits",
    "credit_icon": "https://cdn.schematichq.com/icons/credit-premium.svg",
    "expiry_unit_count": 3,
    "plural_name": "Premium Data Credits",
    "price": {
      "currency": "USD",
      "external_price_id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
      "id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
      "interval": "day",
      "price": 1500,
      "provider_type": "schematic",
      "scheme": "per_unit",
      "price_decimal": "15.00"
    },
    "quantity": 100,
    "singular_name": "Premium Data Credit",
    "unit_price": {
      "currency": "USD",
      "external_price_id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
      "id": "price_1Hh1YZ2eZvKYlo2C3X9a1b2c",
      "interval": "day",
      "price": 1500,
      "provider_type": "schematic",
      "scheme": "per_unit",
      "price_decimal": "15.00"
    }
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

bundle_namestringRequired<=256 characters

credit_idstringRequired

currencystringRequired

price_per_unitlongRequired>=0

bundle_typeenum or nullOptional

Allowed values:

currency_priceslist of objects or nullOptional

expiry_typeenum or nullOptional

Allowed values:

expiry_unitenum or nullOptional

Allowed values:

expiry_unit_countlong or nullOptional>=1

price_per_unit_decimalstring or nullOptional

quantitylong or nullOptional>=1

statusenum 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