Upsert company

POST

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

idstringOptional

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

last_seen_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

namestringOptional

traitsmap from strings to anyOptional

A map of trait names to trait values

update_onlybooleanOptionalDefaults to false

Response

dataobject

paramsmap from strings to any

Input parameters

POST

1 curl -X POST https://api.schematichq.com/companies \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "keys": {
6     "key": "value"
7   }
8 }'

200Successful

1 {
2   "data": {
3     "add_ons": [
4       {
5         "id": "id",
6         "name": "name"
7       }
8     ],
9     "billing_subscriptions": [
10       {
11         "created_at": "2024-01-15T09:30:00Z",
12         "currency": "currency",
13         "customer_external_id": "customer_external_id",
14         "discounts": [
15           {
16             "coupon_id": "coupon_id",
17             "coupon_name": "coupon_name",
18             "discount_external_id": "discount_external_id",
19             "duration": "duration",
20             "is_active": true,
21             "started_at": "2024-01-15T09:30:00Z",
22             "subscription_external_id": "subscription_external_id"
23           }
24         ],
25         "id": "id",
26         "interval": "interval",
27         "period_end": 1,
28         "period_start": 1,
29         "products": [
30           {
31             "created_at": "2024-01-15T09:30:00Z",
32             "currency": "currency",
33             "environment_id": "environment_id",
34             "external_id": "external_id",
35             "id": "id",
36             "interval": "interval",
37             "name": "name",
38             "price": 1,
39             "price_external_id": "price_external_id",
40             "price_id": "price_id",
41             "quantity": 1.1,
42             "subscription_id": "subscription_id",
43             "updated_at": "2024-01-15T09:30:00Z",
44             "usage_type": "usage_type"
45           }
46         ],
47         "status": "status",
48         "subscription_external_id": "subscription_external_id",
49         "total_price": 1
50       }
51     ],
52     "created_at": "2024-01-15T09:30:00Z",
53     "entity_traits": [
54       {
55         "created_at": "2024-01-15T09:30:00Z",
56         "definition_id": "definition_id",
57         "environment_id": "environment_id",
58         "id": "id",
59         "updated_at": "2024-01-15T09:30:00Z",
60         "value": "value"
61       }
62     ],
63     "environment_id": "environment_id",
64     "id": "id",
65     "keys": [
66       {
67         "created_at": "2024-01-15T09:30:00Z",
68         "definition_id": "definition_id",
69         "entity_id": "entity_id",
70         "entity_type": "entity_type",
71         "environment_id": "environment_id",
72         "id": "id",
73         "key": "key",
74         "updated_at": "2024-01-15T09:30:00Z",
75         "value": "value"
76       }
77     ],
78     "name": "name",
79     "plans": [
80       {
81         "id": "id",
82         "name": "name"
83       }
84     ],
85     "updated_at": "2024-01-15T09:30:00Z",
86     "user_count": 1,
87     "billing_subscription": {
88       "created_at": "2024-01-15T09:30:00Z",
89       "currency": "currency",
90       "customer_external_id": "customer_external_id",
91       "discounts": [
92         {
93           "coupon_id": "coupon_id",
94           "coupon_name": "coupon_name",
95           "discount_external_id": "discount_external_id",
96           "duration": "duration",
97           "is_active": true,
98           "started_at": "2024-01-15T09:30:00Z",
99           "subscription_external_id": "subscription_external_id"
100         }
101       ],
102       "id": "id",
103       "interval": "interval",
104       "period_end": 1,
105       "period_start": 1,
106       "products": [
107         {
108           "created_at": "2024-01-15T09:30:00Z",
109           "currency": "currency",
110           "environment_id": "environment_id",
111           "external_id": "external_id",
112           "id": "id",
113           "interval": "interval",
114           "name": "name",
115           "price": 1,
116           "price_external_id": "price_external_id",
117           "price_id": "price_id",
118           "quantity": 1.1,
119           "subscription_id": "subscription_id",
120           "updated_at": "2024-01-15T09:30:00Z",
121           "usage_type": "usage_type"
122         }
123       ],
124       "status": "status",
125       "subscription_external_id": "subscription_external_id",
126       "total_price": 1,
127       "company_id": "company_id",
128       "expired_at": "2024-01-15T09:30:00Z",
129       "latest_invoice": {
130         "amount_due": 1,
131         "amount_paid": 1,
132         "amount_remaining": 1,
133         "collection_method": "collection_method",
134         "created_at": "2024-01-15T09:30:00Z",
135         "currency": "currency",
136         "customer_external_id": "customer_external_id",
137         "environment_id": "environment_id",
138         "id": "id",
139         "subtotal": 1,
140         "updated_at": "2024-01-15T09:30:00Z"
141       },
142       "metadata": {
143         "key": "value"
144       },
145       "payment_method": {
146         "created_at": "2024-01-15T09:30:00Z",
147         "customer_external_id": "customer_external_id",
148         "environment_id": "environment_id",
149         "external_id": "external_id",
150         "id": "id",
151         "payment_method_type": "payment_method_type",
152         "updated_at": "2024-01-15T09:30:00Z"
153       },
154       "trial_end": 1
155     },
156     "last_seen_at": "2024-01-15T09:30:00Z",
157     "logo_url": "logo_url",
158     "plan": {
159       "id": "id",
160       "name": "name",
161       "billing_product_id": "billing_product_id",
162       "description": "description",
163       "image_url": "image_url",
164       "plan_period": "plan_period",
165       "plan_price": 1
166     },
167     "traits": {
168       "key": "value"
169     }
170   },
171   "params": {
172     "key": "value"
173   }
174 }

Built with

1	curl -X POST https://api.schematichq.com/companies \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"keys": {
6	"key": "value"
7	}
8	}'

1	{
2	"data": {
3	"add_ons": [
4	{
5	"id": "id",
6	"name": "name"
7	}
8	],
9	"billing_subscriptions": [
10	{
11	"created_at": "2024-01-15T09:30:00Z",
12	"currency": "currency",
13	"customer_external_id": "customer_external_id",
14	"discounts": [
15	{
16	"coupon_id": "coupon_id",
17	"coupon_name": "coupon_name",
18	"discount_external_id": "discount_external_id",
19	"duration": "duration",
20	"is_active": true,
21	"started_at": "2024-01-15T09:30:00Z",
22	"subscription_external_id": "subscription_external_id"
23	}
24	],
25	"id": "id",
26	"interval": "interval",
27	"period_end": 1,
28	"period_start": 1,
29	"products": [
30	{
31	"created_at": "2024-01-15T09:30:00Z",
32	"currency": "currency",
33	"environment_id": "environment_id",
34	"external_id": "external_id",
35	"id": "id",
36	"interval": "interval",
37	"name": "name",
38	"price": 1,
39	"price_external_id": "price_external_id",
40	"price_id": "price_id",
41	"quantity": 1.1,
42	"subscription_id": "subscription_id",
43	"updated_at": "2024-01-15T09:30:00Z",
44	"usage_type": "usage_type"
45	}
46	],
47	"status": "status",
48	"subscription_external_id": "subscription_external_id",
49	"total_price": 1
50	}
51	],
52	"created_at": "2024-01-15T09:30:00Z",
53	"entity_traits": [
54	{
55	"created_at": "2024-01-15T09:30:00Z",
56	"definition_id": "definition_id",
57	"environment_id": "environment_id",
58	"id": "id",
59	"updated_at": "2024-01-15T09:30:00Z",
60	"value": "value"
61	}
62	],
63	"environment_id": "environment_id",
64	"id": "id",
65	"keys": [
66	{
67	"created_at": "2024-01-15T09:30:00Z",
68	"definition_id": "definition_id",
69	"entity_id": "entity_id",
70	"entity_type": "entity_type",
71	"environment_id": "environment_id",
72	"id": "id",
73	"key": "key",
74	"updated_at": "2024-01-15T09:30:00Z",
75	"value": "value"
76	}
77	],
78	"name": "name",
79	"plans": [
80	{
81	"id": "id",
82	"name": "name"
83	}
84	],
85	"updated_at": "2024-01-15T09:30:00Z",
86	"user_count": 1,
87	"billing_subscription": {
88	"created_at": "2024-01-15T09:30:00Z",
89	"currency": "currency",
90	"customer_external_id": "customer_external_id",
91	"discounts": [
92	{
93	"coupon_id": "coupon_id",
94	"coupon_name": "coupon_name",
95	"discount_external_id": "discount_external_id",
96	"duration": "duration",
97	"is_active": true,
98	"started_at": "2024-01-15T09:30:00Z",
99	"subscription_external_id": "subscription_external_id"
100	}
101	],
102	"id": "id",
103	"interval": "interval",
104	"period_end": 1,
105	"period_start": 1,
106	"products": [
107	{
108	"created_at": "2024-01-15T09:30:00Z",
109	"currency": "currency",
110	"environment_id": "environment_id",
111	"external_id": "external_id",
112	"id": "id",
113	"interval": "interval",
114	"name": "name",
115	"price": 1,
116	"price_external_id": "price_external_id",
117	"price_id": "price_id",
118	"quantity": 1.1,
119	"subscription_id": "subscription_id",
120	"updated_at": "2024-01-15T09:30:00Z",
121	"usage_type": "usage_type"
122	}
123	],
124	"status": "status",
125	"subscription_external_id": "subscription_external_id",
126	"total_price": 1,
127	"company_id": "company_id",
128	"expired_at": "2024-01-15T09:30:00Z",
129	"latest_invoice": {
130	"amount_due": 1,
131	"amount_paid": 1,
132	"amount_remaining": 1,
133	"collection_method": "collection_method",
134	"created_at": "2024-01-15T09:30:00Z",
135	"currency": "currency",
136	"customer_external_id": "customer_external_id",
137	"environment_id": "environment_id",
138	"id": "id",
139	"subtotal": 1,
140	"updated_at": "2024-01-15T09:30:00Z"
141	},
142	"metadata": {
143	"key": "value"
144	},
145	"payment_method": {
146	"created_at": "2024-01-15T09:30:00Z",
147	"customer_external_id": "customer_external_id",
148	"environment_id": "environment_id",
149	"external_id": "external_id",
150	"id": "id",
151	"payment_method_type": "payment_method_type",
152	"updated_at": "2024-01-15T09:30:00Z"
153	},
154	"trial_end": 1
155	},
156	"last_seen_at": "2024-01-15T09:30:00Z",
157	"logo_url": "logo_url",
158	"plan": {
159	"id": "id",
160	"name": "name",
161	"billing_product_id": "billing_product_id",
162	"description": "description",
163	"image_url": "image_url",
164	"plan_period": "plan_period",
165	"plan_price": 1
166	},
167	"traits": {
168	"key": "value"
169	}
170	},
171	"params": {
172	"key": "value"
173	}
174	}