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": "id",
6         "name": "name"
7       }
8     ],
9     "billing_subscriptions": [
10       {
11         "cancel_at_period_end": true,
12         "created_at": "2024-01-15T09:30:00Z",
13         "currency": "currency",
14         "customer_external_id": "customer_external_id",
15         "discounts": [
16           {
17             "coupon_id": "coupon_id",
18             "coupon_name": "coupon_name",
19             "discount_external_id": "discount_external_id",
20             "duration": "duration",
21             "is_active": true,
22             "started_at": "2024-01-15T09:30:00Z",
23             "subscription_external_id": "subscription_external_id"
24           }
25         ],
26         "id": "id",
27         "interval": "interval",
28         "period_end": 1,
29         "period_start": 1,
30         "products": [
31           {
32             "billing_scheme": "billing_scheme",
33             "created_at": "2024-01-15T09:30:00Z",
34             "currency": "currency",
35             "environment_id": "environment_id",
36             "external_id": "external_id",
37             "id": "id",
38             "interval": "interval",
39             "name": "name",
40             "package_size": 1,
41             "price": 1,
42             "price_external_id": "price_external_id",
43             "price_id": "price_id",
44             "price_tier": [
45               {}
46             ],
47             "quantity": 1.1,
48             "subscription_id": "subscription_id",
49             "updated_at": "2024-01-15T09:30:00Z",
50             "usage_type": "usage_type"
51           }
52         ],
53         "status": "status",
54         "subscription_external_id": "subscription_external_id",
55         "total_price": 1
56       }
57     ],
58     "created_at": "2024-01-15T09:30:00Z",
59     "entity_traits": [
60       {
61         "created_at": "2024-01-15T09:30:00Z",
62         "definition_id": "definition_id",
63         "environment_id": "environment_id",
64         "id": "id",
65         "updated_at": "2024-01-15T09:30:00Z",
66         "value": "value"
67       }
68     ],
69     "environment_id": "environment_id",
70     "id": "id",
71     "keys": [
72       {
73         "created_at": "2024-01-15T09:30:00Z",
74         "definition_id": "definition_id",
75         "entity_id": "entity_id",
76         "entity_type": "entity_type",
77         "environment_id": "environment_id",
78         "id": "id",
79         "key": "key",
80         "updated_at": "2024-01-15T09:30:00Z",
81         "value": "value"
82       }
83     ],
84     "metrics": [
85       {
86         "account_id": "account_id",
87         "captured_at_max": "2024-01-15T09:30:00Z",
88         "captured_at_min": "2024-01-15T09:30:00Z",
89         "company_id": "company_id",
90         "created_at": "2024-01-15T09:30:00Z",
91         "environment_id": "environment_id",
92         "event_subtype": "event_subtype",
93         "month_reset": "month_reset",
94         "period": "period",
95         "value": 1
96       }
97     ],
98     "name": "name",
99     "payment_methods": [
100       {
101         "created_at": "2024-01-15T09:30:00Z",
102         "customer_external_id": "customer_external_id",
103         "environment_id": "environment_id",
104         "external_id": "external_id",
105         "id": "id",
106         "payment_method_type": "payment_method_type",
107         "updated_at": "2024-01-15T09:30:00Z"
108       }
109     ],
110     "plans": [
111       {
112         "id": "id",
113         "name": "name"
114       }
115     ],
116     "updated_at": "2024-01-15T09:30:00Z",
117     "user_count": 1,
118     "billing_subscription": {
119       "cancel_at_period_end": true,
120       "created_at": "2024-01-15T09:30:00Z",
121       "currency": "currency",
122       "customer_external_id": "customer_external_id",
123       "discounts": [
124         {
125           "coupon_id": "coupon_id",
126           "coupon_name": "coupon_name",
127           "discount_external_id": "discount_external_id",
128           "duration": "duration",
129           "is_active": true,
130           "started_at": "2024-01-15T09:30:00Z",
131           "subscription_external_id": "subscription_external_id"
132         }
133       ],
134       "id": "id",
135       "interval": "interval",
136       "period_end": 1,
137       "period_start": 1,
138       "products": [
139         {
140           "billing_scheme": "billing_scheme",
141           "created_at": "2024-01-15T09:30:00Z",
142           "currency": "currency",
143           "environment_id": "environment_id",
144           "external_id": "external_id",
145           "id": "id",
146           "interval": "interval",
147           "name": "name",
148           "package_size": 1,
149           "price": 1,
150           "price_external_id": "price_external_id",
151           "price_id": "price_id",
152           "price_tier": [
153             {}
154           ],
155           "quantity": 1.1,
156           "subscription_id": "subscription_id",
157           "updated_at": "2024-01-15T09:30:00Z",
158           "usage_type": "usage_type"
159         }
160       ],
161       "status": "status",
162       "subscription_external_id": "subscription_external_id",
163       "total_price": 1,
164       "cancel_at": 1,
165       "company_id": "company_id",
166       "default_payment_method_id": "default_payment_method_id",
167       "expired_at": "2024-01-15T09:30:00Z",
168       "latest_invoice": {
169         "amount_due": 1,
170         "amount_paid": 1,
171         "amount_remaining": 1,
172         "collection_method": "collection_method",
173         "created_at": "2024-01-15T09:30:00Z",
174         "currency": "currency",
175         "customer_external_id": "customer_external_id",
176         "environment_id": "environment_id",
177         "id": "id",
178         "subtotal": 1,
179         "updated_at": "2024-01-15T09:30:00Z"
180       },
181       "metadata": {
182         "key": "value"
183       },
184       "payment_method": {
185         "created_at": "2024-01-15T09:30:00Z",
186         "customer_external_id": "customer_external_id",
187         "environment_id": "environment_id",
188         "external_id": "external_id",
189         "id": "id",
190         "payment_method_type": "payment_method_type",
191         "updated_at": "2024-01-15T09:30:00Z"
192       },
193       "trial_end": 1,
194       "trial_end_setting": "trial_end_setting"
195     },
196     "default_payment_method": {
197       "created_at": "2024-01-15T09:30:00Z",
198       "customer_external_id": "customer_external_id",
199       "environment_id": "environment_id",
200       "external_id": "external_id",
201       "id": "id",
202       "payment_method_type": "payment_method_type",
203       "updated_at": "2024-01-15T09:30:00Z",
204       "account_last4": "account_last4",
205       "account_name": "account_name",
206       "bank_name": "bank_name",
207       "billing_email": "billing_email",
208       "billing_name": "billing_name",
209       "card_brand": "card_brand",
210       "card_exp_month": 1,
211       "card_exp_year": 1,
212       "card_last4": "card_last4",
213       "company_id": "company_id"
214     },
215     "last_seen_at": "2024-01-15T09:30:00Z",
216     "logo_url": "logo_url",
217     "plan": {
218       "id": "id",
219       "name": "name",
220       "added_on": "2024-01-15T09:30:00Z",
221       "billing_product_external_id": "billing_product_external_id",
222       "billing_product_id": "billing_product_id",
223       "description": "description",
224       "image_url": "image_url",
225       "plan_period": "plan_period",
226       "plan_price": 1
227     },
228     "traits": {
229       "key": "value"
230     }
231   },
232   "params": {
233     "key": "value"
234   }
235 }

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

See Key Management for more information

idstringOptional

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

last_seen_atdatetimeOptional

namestringOptional

traitsmap from strings to anyOptional

A map of trait names to trait values

update_onlybooleanOptional

Response

dataobject

paramsmap from strings to any

Input parameters

Upsert company

Headers

Request

Response

Errors