List credits

GET

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

GET

/billing/credits

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.credits.listBillingCredits({
5     name: "name",
6     limit: 1,
7     offset: 1
8 });

Try it

1 {
2   "data": [
3     {
4       "burn_strategy": "string",
5       "created_at": "2024-01-15T09:30:00Z",
6       "default_expiry_unit": "string",
7       "default_rollover_policy": "string",
8       "description": "string",
9       "id": "string",
10       "name": "string",
11       "updated_at": "2024-01-15T09:30:00Z",
12       "default_expiry_unit_count": 1,
13       "icon": "string",
14       "plural_name": "string",
15       "price": {
16         "currency": "string",
17         "external_price_id": "string",
18         "id": "string",
19         "interval": "string",
20         "price": 1,
21         "scheme": "string",
22         "price_decimal": "string"
23       },
24       "product": {
25         "account_id": "string",
26         "created_at": "2024-01-15T09:30:00Z",
27         "environment_id": "string",
28         "external_id": "string",
29         "is_active": true,
30         "name": "string",
31         "price": 1.1,
32         "product_id": "string",
33         "quantity": 1.1,
34         "updated_at": "2024-01-15T09:30:00Z",
35         "price_decimal": "string",
36         "currency": "string"
37       },
38       "singular_name": "string"
39     }
40   ],
41   "params": {
42     "ids": [
43       "string"
44     ],
45     "limit": "100",
46     "name": "string",
47     "offset": "0"
48   }
49 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

idslist of stringsOptional

namestringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors