List credit bundles

GET

https://api.schematichq.com/billing/credits/bundles

GET

/billing/credits/bundles

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.credits.listCreditBundles({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "bundle_type": "fixed",
5       "created_at": "2024-01-15T09:30:00Z",
6       "credit_id": "cred_abc123",
7       "credit_name": "API Credit Pack",
8       "currency_prices": [
9         {
10           "currency": "USD",
11           "price": {
12             "currency": "USD",
13             "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
14             "id": "price_usd_001",
15             "interval": "one-time",
16             "price": 4999,
17             "provider_type": "stripe",
18             "scheme": "per_unit",
19             "price_decimal": "49.99"
20           }
21         }
22       ],
23       "expiry_type": "duration",
24       "expiry_unit": "billing_periods",
25       "has_grants": true,
26       "id": "bundle_001",
27       "name": "Standard Credit Bundle",
28       "status": "active",
29       "updated_at": "2024-01-15T09:30:00Z",
30       "billing_invoice_id": "inv_20240115_001",
31       "credit_description": "Access to 100 API credits for data processing",
32       "credit_icon": "https://cdn.schematichq.com/icons/api-credits.png",
33       "expiry_unit_count": 3,
34       "plural_name": "Standard Credit Bundles",
35       "price": {
36         "currency": "USD",
37         "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
38         "id": "price_usd_001",
39         "interval": "one-time",
40         "price": 4999,
41         "provider_type": "stripe",
42         "scheme": "per_unit",
43         "price_decimal": "49.99"
44       },
45       "quantity": 100,
46       "singular_name": "Standard Credit Bundle",
47       "unit_price": {
48         "currency": "USD",
49         "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
50         "id": "price_usd_001",
51         "interval": "one-time",
52         "price": 4999,
53         "provider_type": "stripe",
54         "scheme": "per_unit",
55         "price_decimal": "49.99"
56       }
57     }
58   ],
59   "params": {
60     "bundle_type": "fixed",
61     "credit_id": "cred_abc123",
62     "ids": [
63       "bundle_001"
64     ],
65     "limit": 100,
66     "offset": 0,
67     "status": "active"
68   }
69 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

idslist of stringsOptional

credit_idstringOptional

statusenumOptional

Allowed values:

bundle_typeenumOptional

Allowed values:

limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error