1
import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3
const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4
await client.companies.lookupCompany({
5
    keys: {
6
        "keys": "keys"
7
    }
8
});

1
{
2
  "data": {
3
    "add_ons": [
4
      {
5
        "id": "string",
6
        "name": "string",
7
        "added_on": "2024-01-15T09:30:00Z",
8
        "billing_product_external_id": "string",
9
        "billing_product_id": "string",
10
        "description": "string",
11
        "image_url": "string",
12
        "plan_period": "string",
13
        "plan_price": 1
14
      }
15
    ],
16
    "billing_subscriptions": [
17
      {
18
        "cancel_at_period_end": true,
19
        "created_at": "2024-01-15T09:30:00Z",
20
        "currency": "string",
21
        "customer_external_id": "string",
22
        "discounts": [
23
          {
24
            "coupon_id": "string",
25
            "coupon_name": "string",
26
            "discount_external_id": "string",
27
            "duration": "string",
28
            "is_active": true,
29
            "started_at": "2024-01-15T09:30:00Z",
30
            "subscription_external_id": "string",
31
            "amount_off": 1,
32
            "currency": "string",
33
            "customer_facing_code": "string",
34
            "duration_in_months": 1,
35
            "ended_at": "2024-01-15T09:30:00Z",
36
            "percent_off": 1.1,
37
            "promo_code_external_id": "string"
38
          }
39
        ],
40
        "id": "string",
41
        "interval": "string",
42
        "period_end": 1,
43
        "period_start": 1,
44
        "products": [
45
          {
46
            "billing_scheme": "string",
47
            "created_at": "2024-01-15T09:30:00Z",
48
            "currency": "string",
49
            "environment_id": "string",
50
            "external_id": "string",
51
            "id": "string",
52
            "interval": "string",
53
            "name": "string",
54
            "package_size": 1,
55
            "price": 1,
56
            "price_external_id": "string",
57
            "price_id": "string",
58
            "price_tier": [
59
              {
60
                "flat_amount": 1,
61
                "per_unit_price": 1,
62
                "per_unit_price_decimal": "string",
63
                "up_to": 1
64
              }
65
            ],
66
            "quantity": 1.1,
67
            "subscription_id": "string",
68
            "updated_at": "2024-01-15T09:30:00Z",
69
            "usage_type": "string",
70
            "billing_threshold": 1,
71
            "meter_id": "string",
72
            "price_decimal": "string",
73
            "subscription_item_external_id": "string"
74
          }
75
        ],
76
        "status": "string",
77
        "subscription_external_id": "string",
78
        "total_price": 1,
79
        "cancel_at": 1,
80
        "company_id": "string",
81
        "default_payment_method_id": "string",
82
        "expired_at": "2024-01-15T09:30:00Z",
83
        "latest_invoice": {
84
          "amount_due": 1,
85
          "amount_paid": 1,
86
          "amount_remaining": 1,
87
          "collection_method": "string",
88
          "created_at": "2024-01-15T09:30:00Z",
89
          "currency": "string",
90
          "customer_external_id": "string",
91
          "environment_id": "string",
92
          "id": "string",
93
          "subtotal": 1,
94
          "updated_at": "2024-01-15T09:30:00Z",
95
          "company_id": "string",
96
          "due_date": "2024-01-15T09:30:00Z",
97
          "external_id": "string",
98
          "payment_method_external_id": "string",
99
          "subscription_external_id": "string",
100
          "url": "string"
101
        },
102
        "metadata": {},
103
        "payment_method": {
104
          "created_at": "2024-01-15T09:30:00Z",
105
          "customer_external_id": "string",
106
          "environment_id": "string",
107
          "external_id": "string",
108
          "id": "string",
109
          "payment_method_type": "string",
110
          "updated_at": "2024-01-15T09:30:00Z",
111
          "account_last4": "string",
112
          "account_name": "string",
113
          "bank_name": "string",
114
          "billing_email": "string",
115
          "billing_name": "string",
116
          "card_brand": "string",
117
          "card_exp_month": 1,
118
          "card_exp_year": 1,
119
          "card_last4": "string",
120
          "company_id": "string"
121
        },
122
        "trial_end": 1,
123
        "trial_end_setting": "string"
124
      }
125
    ],
126
    "created_at": "2024-01-15T09:30:00Z",
127
    "entity_traits": [
128
      {
129
        "created_at": "2024-01-15T09:30:00Z",
130
        "definition_id": "string",
131
        "environment_id": "string",
132
        "id": "string",
133
        "updated_at": "2024-01-15T09:30:00Z",
134
        "value": "string",
135
        "definition": {
136
          "created_at": "2024-01-15T09:30:00Z",
137
          "display_name": "string",
138
          "entity_type": "string",
139
          "hierarchy": [
140
            "string"
141
          ],
142
          "id": "string",
143
          "trait_type": "string",
144
          "updated_at": "2024-01-15T09:30:00Z"
145
        }
146
      }
147
    ],
148
    "environment_id": "string",
149
    "id": "string",
150
    "keys": [
151
      {
152
        "created_at": "2024-01-15T09:30:00Z",
153
        "definition_id": "string",
154
        "entity_id": "string",
155
        "entity_type": "string",
156
        "environment_id": "string",
157
        "id": "string",
158
        "key": "string",
159
        "updated_at": "2024-01-15T09:30:00Z",
160
        "value": "string",
161
        "definition": {
162
          "created_at": "2024-01-15T09:30:00Z",
163
          "entity_type": "string",
164
          "id": "string",
165
          "key": "string",
166
          "updated_at": "2024-01-15T09:30:00Z"
167
        }
168
      }
169
    ],
170
    "metrics": [
171
      {
172
        "account_id": "string",
173
        "captured_at_max": "2024-01-15T09:30:00Z",
174
        "captured_at_min": "2024-01-15T09:30:00Z",
175
        "company_id": "string",
176
        "created_at": "2024-01-15T09:30:00Z",
177
        "environment_id": "string",
178
        "event_subtype": "string",
179
        "month_reset": "string",
180
        "period": "string",
181
        "value": 1,
182
        "valid_until": "2024-01-15T09:30:00Z"
183
      }
184
    ],
185
    "name": "string",
186
    "payment_methods": [
187
      {
188
        "created_at": "2024-01-15T09:30:00Z",
189
        "customer_external_id": "string",
190
        "environment_id": "string",
191
        "external_id": "string",
192
        "id": "string",
193
        "payment_method_type": "string",
194
        "updated_at": "2024-01-15T09:30:00Z",
195
        "account_last4": "string",
196
        "account_name": "string",
197
        "bank_name": "string",
198
        "billing_email": "string",
199
        "billing_name": "string",
200
        "card_brand": "string",
201
        "card_exp_month": 1,
202
        "card_exp_year": 1,
203
        "card_last4": "string",
204
        "company_id": "string"
205
      }
206
    ],
207
    "plans": [
208
      {
209
        "id": "string",
210
        "name": "string",
211
        "description": "string",
212
        "image_url": "string"
213
      }
214
    ],
215
    "rules": [
216
      {
217
        "account_id": "string",
218
        "condition_groups": [
219
          {
220
            "conditions": [
221
              {
222
                "account_id": "string",
223
                "condition_type": "string",
224
                "environment_id": "string",
225
                "id": "string",
226
                "operator": "string",
227
                "resource_ids": [
228
                  "string"
229
                ],
230
                "trait_value": "string",
231
                "comparison_trait_definition": {
232
                  "comparable_type": "string",
233
                  "entity_type": "string",
234
                  "id": "string"
235
                },
236
                "consumption_rate": 1.1,
237
                "credit_id": "string",
238
                "event_subtype": "string",
239
                "metric_period": "string",
240
                "metric_period_month_reset": "string",
241
                "metric_value": 1,
242
                "trait_definition": {
243
                  "comparable_type": "string",
244
                  "entity_type": "string",
245
                  "id": "string"
246
                }
247
              }
248
            ]
249
          }
250
        ],
251
        "conditions": [
252
          {
253
            "account_id": "string",
254
            "condition_type": "string",
255
            "environment_id": "string",
256
            "id": "string",
257
            "operator": "string",
258
            "resource_ids": [
259
              "string"
260
            ],
261
            "trait_value": "string",
262
            "comparison_trait_definition": {
263
              "comparable_type": "string",
264
              "entity_type": "string",
265
              "id": "string"
266
            },
267
            "consumption_rate": 1.1,
268
            "credit_id": "string",
269
            "event_subtype": "string",
270
            "metric_period": "string",
271
            "metric_period_month_reset": "string",
272
            "metric_value": 1,
273
            "trait_definition": {
274
              "comparable_type": "string",
275
              "entity_type": "string",
276
              "id": "string"
277
            }
278
          }
279
        ],
280
        "environment_id": "string",
281
        "id": "string",
282
        "name": "string",
283
        "priority": 1,
284
        "rule_type": "string",
285
        "value": true,
286
        "flag_id": "string"
287
      }
288
    ],
289
    "updated_at": "2024-01-15T09:30:00Z",
290
    "user_count": 1,
291
    "billing_credit_balances": {},
292
    "billing_subscription": {
293
      "cancel_at_period_end": true,
294
      "created_at": "2024-01-15T09:30:00Z",
295
      "currency": "string",
296
      "customer_external_id": "string",
297
      "discounts": [
298
        {
299
          "coupon_id": "string",
300
          "coupon_name": "string",
301
          "discount_external_id": "string",
302
          "duration": "string",
303
          "is_active": true,
304
          "started_at": "2024-01-15T09:30:00Z",
305
          "subscription_external_id": "string",
306
          "amount_off": 1,
307
          "currency": "string",
308
          "customer_facing_code": "string",
309
          "duration_in_months": 1,
310
          "ended_at": "2024-01-15T09:30:00Z",
311
          "percent_off": 1.1,
312
          "promo_code_external_id": "string"
313
        }
314
      ],
315
      "id": "string",
316
      "interval": "string",
317
      "period_end": 1,
318
      "period_start": 1,
319
      "products": [
320
        {
321
          "billing_scheme": "string",
322
          "created_at": "2024-01-15T09:30:00Z",
323
          "currency": "string",
324
          "environment_id": "string",
325
          "external_id": "string",
326
          "id": "string",
327
          "interval": "string",
328
          "name": "string",
329
          "package_size": 1,
330
          "price": 1,
331
          "price_external_id": "string",
332
          "price_id": "string",
333
          "price_tier": [
334
            {
335
              "flat_amount": 1,
336
              "per_unit_price": 1,
337
              "per_unit_price_decimal": "string",
338
              "up_to": 1
339
            }
340
          ],
341
          "quantity": 1.1,
342
          "subscription_id": "string",
343
          "updated_at": "2024-01-15T09:30:00Z",
344
          "usage_type": "string",
345
          "billing_threshold": 1,
346
          "meter_id": "string",
347
          "price_decimal": "string",
348
          "subscription_item_external_id": "string"
349
        }
350
      ],
351
      "status": "string",
352
      "subscription_external_id": "string",
353
      "total_price": 1,
354
      "cancel_at": 1,
355
      "company_id": "string",
356
      "default_payment_method_id": "string",
357
      "expired_at": "2024-01-15T09:30:00Z",
358
      "latest_invoice": {
359
        "amount_due": 1,
360
        "amount_paid": 1,
361
        "amount_remaining": 1,
362
        "collection_method": "string",
363
        "created_at": "2024-01-15T09:30:00Z",
364
        "currency": "string",
365
        "customer_external_id": "string",
366
        "environment_id": "string",
367
        "id": "string",
368
        "subtotal": 1,
369
        "updated_at": "2024-01-15T09:30:00Z",
370
        "company_id": "string",
371
        "due_date": "2024-01-15T09:30:00Z",
372
        "external_id": "string",
373
        "payment_method_external_id": "string",
374
        "subscription_external_id": "string",
375
        "url": "string"
376
      },
377
      "metadata": {},
378
      "payment_method": {
379
        "created_at": "2024-01-15T09:30:00Z",
380
        "customer_external_id": "string",
381
        "environment_id": "string",
382
        "external_id": "string",
383
        "id": "string",
384
        "payment_method_type": "string",
385
        "updated_at": "2024-01-15T09:30:00Z",
386
        "account_last4": "string",
387
        "account_name": "string",
388
        "bank_name": "string",
389
        "billing_email": "string",
390
        "billing_name": "string",
391
        "card_brand": "string",
392
        "card_exp_month": 1,
393
        "card_exp_year": 1,
394
        "card_last4": "string",
395
        "company_id": "string"
396
      },
397
      "trial_end": 1,
398
      "trial_end_setting": "string"
399
    },
400
    "default_payment_method": {
401
      "created_at": "2024-01-15T09:30:00Z",
402
      "customer_external_id": "string",
403
      "environment_id": "string",
404
      "external_id": "string",
405
      "id": "string",
406
      "payment_method_type": "string",
407
      "updated_at": "2024-01-15T09:30:00Z",
408
      "account_last4": "string",
409
      "account_name": "string",
410
      "bank_name": "string",
411
      "billing_email": "string",
412
      "billing_name": "string",
413
      "card_brand": "string",
414
      "card_exp_month": 1,
415
      "card_exp_year": 1,
416
      "card_last4": "string",
417
      "company_id": "string"
418
    },
419
    "last_seen_at": "2024-01-15T09:30:00Z",
420
    "logo_url": "string",
421
    "plan": {
422
      "id": "string",
423
      "name": "string",
424
      "added_on": "2024-01-15T09:30:00Z",
425
      "billing_product_external_id": "string",
426
      "billing_product_id": "string",
427
      "description": "string",
428
      "image_url": "string",
429
      "plan_period": "string",
430
      "plan_price": 1
431
    },
432
    "traits": {}
433
  },
434
  "params": {
435
    "keys": {}
436
  }
437
}