Upsert company

POST

https://api.schematichq.com/companies

POST

/companies

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

Try it

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

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

See Key Management for more information

idstring or nullOptional

If you know the Schematic ID, you can use that here instead of keys

last_seen_atstring or nullOptionalformat: "date-time"

namestring or nullOptional

traitsobjectOptional

A map of trait names to trait values

update_onlyboolean or nullOptional

Response

dataobject

paramsobject

Input parameters

Upsert company

Headers

Request

Response

Errors