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 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.credits.listCreditBundles({
5     creditId: "credit_id",
6     status: "active",
7     bundleType: "fixed",
8     limit: 1,
9     offset: 1
10 });

Try it

1 {
2   "data": [
3     {
4       "bundle_type": "string",
5       "created_at": "2024-01-15T09:30:00Z",
6       "credit_id": "string",
7       "credit_name": "string",
8       "expiry_type": "string",
9       "expiry_unit": "string",
10       "has_grants": true,
11       "id": "string",
12       "name": "string",
13       "status": "string",
14       "updated_at": "2024-01-15T09:30:00Z",
15       "billing_invoice_id": "string",
16       "credit_description": "string",
17       "credit_icon": "string",
18       "expiry_unit_count": 1,
19       "plural_name": "string",
20       "price": {
21         "currency": "string",
22         "external_price_id": "string",
23         "id": "string",
24         "interval": "string",
25         "price": 1,
26         "scheme": "string",
27         "price_decimal": "string"
28       },
29       "quantity": 1,
30       "singular_name": "string",
31       "unit_price": {
32         "currency": "string",
33         "external_price_id": "string",
34         "id": "string",
35         "interval": "string",
36         "price": 1,
37         "scheme": "string",
38         "price_decimal": "string"
39       }
40     }
41   ],
42   "params": {
43     "bundle_type": "fixed",
44     "credit_id": "string",
45     "ids": [
46       "string"
47     ],
48     "limit": "100",
49     "offset": "0",
50     "status": "active"
51   }
52 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

idslist of stringsOptional

credit_idstringOptional

statusenumOptional

Allowed values:

bundle_typeenumOptional

Allowed values:

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors