Create company override

POST

Request

This endpoint expects an object.

company_idstringRequired

feature_idstringRequired

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

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

metered_monthly_price_idstringOptional

metered_yearly_price_idstringOptional

metric_periodenumOptional

Allowed values: all_timebillingcurrent_monthcurrent_weekcurrent_day

metric_period_month_reset"first_of_month" or "billing_cycle"Optional

Allowed values: first_of_monthbilling_cycle

value_boolbooleanOptionalDefaults to false

value_numericintegerOptional

value_trait_idstringOptional

Response

Created

dataobject

The updated resource

paramsmap from strings to any

Input parameters

POST

1 curl -X POST https://api.schematichq.com/company-overrides \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "company_id": "company_id",
6   "feature_id": "feature_id",
7   "value_type": "boolean"
8 }'

200Successful

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

Built with

1	curl -X POST https://api.schematichq.com/company-overrides \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"company_id": "company_id",
6	"feature_id": "feature_id",
7	"value_type": "boolean"
8	}'

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