For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
  • Billing Credits
    • GETList credits
    • POSTCreate credit
    • GETGet credit
    • PUTUpdate credit
    • DELDelete credit
    • GETList credit bundles
    • POSTCreate credit bundle
    • GETGet credit bundle
    • PUTUpdate credit bundle
    • DELDelete credit bundle
    • POSTGrant credits to company
    • GETList company credit grants
    • GETList credit grants
    • PUTZero out credit grant
    • GETList plan credit grants
    • POSTCreate plan credit grant
    • DELDelete plan credit grant
    • GETGet credit ledger
  • Account Members
    • GETList account members
    • GETGet account member
LogoLogo
SupportDashboard
Companies

Upsert company trait

POST
https://api.schematichq.com/company-traits
POST
/company-traits
1import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3async function main() {
4    const client = new SchematicClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.companies.upsertCompanyTrait({
8        trait: "string",
9    });
10}
11main();
1{
2  "data": {
3    "add_ons": [
4      {
5        "id": "string",
6        "included_credit_grants": [
7          {
8            "billing_credit_auto_topup_enabled": true,
9            "billing_credit_auto_topup_self_service": true,
10            "created_at": "2024-01-15T09:30:00Z",
11            "credit_amount": 1,
12            "credit_id": "string",
13            "id": "string",
14            "plan_id": "string",
15            "reset_type": "no_reset",
16            "rollover_percentage": 1,
17            "updated_at": "2024-01-15T09:30:00Z",
18            "credit_description": "string",
19            "credit_name": "string",
20            "billing_credit_auto_topup_amount": 1,
21            "billing_credit_auto_topup_amount_type": "string",
22            "billing_credit_auto_topup_expiry_type": "duration",
23            "billing_credit_auto_topup_expiry_unit": "billing_periods",
24            "billing_credit_auto_topup_expiry_unit_count": 1,
25            "billing_credit_auto_topup_threshold_credits": 1,
26            "billing_credit_auto_topup_threshold_percent": 1,
27            "company_auto_topup_amount": 1,
28            "company_auto_topup_enabled": true,
29            "company_auto_topup_threshold_credits": 1,
30            "credit": {
31              "account_id": "string",
32              "burn_strategy": "expiration_priority",
33              "cost_editable": true,
34              "created_at": "2024-01-15T09:30:00Z",
35              "currency_prices": [
36                {
37                  "currency": "string",
38                  "price": {
39                    "billing_scheme": "per_unit",
40                    "created_at": "2024-01-15T09:30:00Z",
41                    "currency": "string",
42                    "id": "string",
43                    "interval": "day",
44                    "interval_count": 1,
45                    "is_active": true,
46                    "package_size": 1,
47                    "price": 1,
48                    "price_external_id": "string",
49                    "price_id": "string",
50                    "price_tier": [
51                      {
52                        "flat_amount": 1,
53                        "per_unit_price": 1,
54                        "per_unit_price_decimal": "string",
55                        "up_to": 1
56                      }
57                    ],
58                    "product_external_id": "string",
59                    "product_id": "string",
60                    "product_name": "string",
61                    "provider_type": "metronome",
62                    "updated_at": "2024-01-15T09:30:00Z",
63                    "usage_type": "licensed",
64                    "meter_event_name": "string",
65                    "meter_event_payload_key": "string",
66                    "meter_id": "string",
67                    "nickname": "string",
68                    "price_decimal": "string",
69                    "tiers_mode": "graduated"
70                  }
71                }
72              ],
73              "default_expiry_unit": "billing_periods",
74              "default_rollover_policy": "expire",
75              "description": "string",
76              "environment_id": "string",
77              "id": "string",
78              "ledger_authority": "schematic_authoritative",
79              "name": "string",
80              "updated_at": "2024-01-15T09:30:00Z",
81              "default_expiry_unit_count": 1,
82              "icon": "string",
83              "plural_name": "string",
84              "price": {
85                "billing_scheme": "per_unit",
86                "created_at": "2024-01-15T09:30:00Z",
87                "currency": "string",
88                "id": "string",
89                "interval": "day",
90                "interval_count": 1,
91                "is_active": true,
92                "package_size": 1,
93                "price": 1,
94                "price_external_id": "string",
95                "price_id": "string",
96                "price_tier": [
97                  {
98                    "flat_amount": 1,
99                    "per_unit_price": 1,
100                    "per_unit_price_decimal": "string",
101                    "up_to": 1
102                  }
103                ],
104                "product_external_id": "string",
105                "product_id": "string",
106                "product_name": "string",
107                "provider_type": "metronome",
108                "updated_at": "2024-01-15T09:30:00Z",
109                "usage_type": "licensed",
110                "meter_event_name": "string",
111                "meter_event_payload_key": "string",
112                "meter_id": "string",
113                "nickname": "string",
114                "price_decimal": "string",
115                "tiers_mode": "graduated"
116              },
117              "price_per_unit": 1,
118              "price_per_unit_decimal": "string",
119              "product": {
120                "account_id": "string",
121                "created_at": "2024-01-15T09:30:00Z",
122                "environment_id": "string",
123                "external_id": "string",
124                "is_active": true,
125                "name": "string",
126                "price": 1.1,
127                "product_id": "string",
128                "provider_type": "metronome",
129                "quantity": 1.1,
130                "updated_at": "2024-01-15T09:30:00Z",
131                "price_decimal": "string",
132                "currency": "string"
133              },
134              "singular_name": "string"
135            },
136            "expiry_type": "duration",
137            "expiry_unit": "billing_periods",
138            "expiry_unit_count": 1,
139            "plan": {
140              "id": "string",
141              "name": "string",
142              "description": "string",
143              "image_url": "string"
144            },
145            "plan_version_id": "string",
146            "reset_cadence": "daily",
147            "reset_start": "billing_period",
148            "credit_icon": "string",
149            "plural_name": "string",
150            "singular_name": "string"
151          }
152        ],
153        "name": "string",
154        "added_on": "2024-01-15T09:30:00Z",
155        "billing_product_external_id": "string",
156        "billing_product_id": "string",
157        "description": "string",
158        "image_url": "string",
159        "plan_period": "string",
160        "plan_price": 1,
161        "plan_version_id": "string"
162      }
163    ],
164    "billing_subscriptions": [
165      {
166        "cancel_at_period_end": true,
167        "created_at": "2024-01-15T09:30:00Z",
168        "currency": "string",
169        "customer_external_id": "string",
170        "discounts": [
171          {
172            "coupon_id": "string",
173            "coupon_name": "string",
174            "discount_external_id": "string",
175            "duration": "string",
176            "is_active": true,
177            "started_at": "2024-01-15T09:30:00Z",
178            "subscription_external_id": "string",
179            "amount_off": 1,
180            "currency": "string",
181            "customer_facing_code": "string",
182            "duration_in_months": 1,
183            "ended_at": "2024-01-15T09:30:00Z",
184            "percent_off": 1.1,
185            "promo_code_external_id": "string"
186          }
187        ],
188        "id": "string",
189        "interval": "string",
190        "period_end": 1,
191        "period_start": 1,
192        "products": [
193          {
194            "billing_scheme": "per_unit",
195            "created_at": "2024-01-15T09:30:00Z",
196            "currency": "string",
197            "environment_id": "string",
198            "external_id": "string",
199            "id": "string",
200            "interval": "string",
201            "name": "string",
202            "package_size": 1,
203            "price": 1,
204            "price_external_id": "string",
205            "price_id": "string",
206            "price_tier": [
207              {
208                "flat_amount": 1,
209                "per_unit_price": 1,
210                "per_unit_price_decimal": "string",
211                "up_to": 1
212              }
213            ],
214            "provider_type": "metronome",
215            "quantity": 1.1,
216            "subscription_id": "string",
217            "updated_at": "2024-01-15T09:30:00Z",
218            "usage_type": "licensed",
219            "billing_threshold": 1,
220            "interval_count": 1,
221            "meter_id": "string",
222            "price_decimal": "string",
223            "subscription_item_external_id": "string"
224          }
225        ],
226        "provider_type": "metronome",
227        "status": "string",
228        "subscription_external_id": "string",
229        "total_price": 1,
230        "application_id": "string",
231        "cancel_at": 1,
232        "company_id": "string",
233        "default_payment_method_id": "string",
234        "expired_at": "2024-01-15T09:30:00Z",
235        "latest_invoice": {
236          "amount_due": 1,
237          "amount_paid": 1,
238          "amount_remaining": 1,
239          "collection_method": "string",
240          "created_at": "2024-01-15T09:30:00Z",
241          "currency": "string",
242          "customer_external_id": "string",
243          "environment_id": "string",
244          "id": "string",
245          "provider_type": "metronome",
246          "subtotal": 1,
247          "updated_at": "2024-01-15T09:30:00Z",
248          "company_id": "string",
249          "due_date": "2024-01-15T09:30:00Z",
250          "external_id": "string",
251          "payment_method_external_id": "string",
252          "status": "draft",
253          "subscription_external_id": "string",
254          "url": "string"
255        },
256        "metadata": {},
257        "payment_method": {
258          "created_at": "2024-01-15T09:30:00Z",
259          "customer_external_id": "string",
260          "environment_id": "string",
261          "external_id": "string",
262          "id": "string",
263          "payment_method_type": "string",
264          "provider_type": "metronome",
265          "updated_at": "2024-01-15T09:30:00Z",
266          "account_last4": "string",
267          "account_name": "string",
268          "bank_name": "string",
269          "billing_email": "string",
270          "billing_name": "string",
271          "card_brand": "string",
272          "card_exp_month": 1,
273          "card_exp_year": 1,
274          "card_last4": "string",
275          "company_id": "string"
276        },
277        "trial_end": 1,
278        "trial_end_setting": "cancel"
279      }
280    ],
281    "created_at": "2024-01-15T09:30:00Z",
282    "custom_plan_billings": [
283      {
284        "activation_strategy": "on_payment",
285        "company_id": "string",
286        "created_at": "2024-01-15T09:30:00Z",
287        "days_until_due": 1,
288        "id": "string",
289        "plan_id": "string",
290        "status": "active",
291        "updated_at": "2024-01-15T09:30:00Z",
292        "external_invoice_id": "string",
293        "paid_at": "2024-01-15T09:30:00Z",
294        "published_at": "2024-01-15T09:30:00Z",
295        "stripe_invoice_url": "string"
296      }
297    ],
298    "entitlements": [
299      {
300        "feature_id": "string",
301        "feature_key": "string",
302        "value_type": "boolean",
303        "allocation": 1,
304        "credit_id": "string",
305        "credit_remaining": 1.1,
306        "credit_total": 1.1,
307        "credit_used": 1.1,
308        "event_name": "string",
309        "metric_period": "all_time",
310        "metric_reset_at": "2024-01-15T09:30:00Z",
311        "month_reset": "billing_cycle",
312        "soft_limit": 1,
313        "usage": 1
314      }
315    ],
316    "entity_traits": [
317      {
318        "created_at": "2024-01-15T09:30:00Z",
319        "definition_id": "string",
320        "environment_id": "string",
321        "id": "string",
322        "updated_at": "2024-01-15T09:30:00Z",
323        "value": "string",
324        "definition": {
325          "created_at": "2024-01-15T09:30:00Z",
326          "display_name": "string",
327          "entity_type": "company",
328          "hierarchy": [
329            "string"
330          ],
331          "id": "string",
332          "trait_type": "boolean",
333          "updated_at": "2024-01-15T09:30:00Z"
334        }
335      }
336    ],
337    "environment_id": "string",
338    "id": "string",
339    "keys": [
340      {
341        "created_at": "2024-01-15T09:30:00Z",
342        "definition_id": "string",
343        "entity_id": "string",
344        "entity_type": "company",
345        "environment_id": "string",
346        "id": "string",
347        "key": "string",
348        "updated_at": "2024-01-15T09:30:00Z",
349        "value": "string",
350        "definition": {
351          "created_at": "2024-01-15T09:30:00Z",
352          "entity_type": "company",
353          "id": "string",
354          "key": "string",
355          "updated_at": "2024-01-15T09:30:00Z"
356        }
357      }
358    ],
359    "metrics": [
360      {
361        "account_id": "string",
362        "captured_at_max": "2024-01-15T09:30:00Z",
363        "captured_at_min": "2024-01-15T09:30:00Z",
364        "company_id": "string",
365        "created_at": "2024-01-15T09:30:00Z",
366        "environment_id": "string",
367        "event_subtype": "string",
368        "month_reset": "billing_cycle",
369        "period": "all_time",
370        "value": 1,
371        "valid_until": "2024-01-15T09:30:00Z"
372      }
373    ],
374    "name": "string",
375    "payment_methods": [
376      {
377        "created_at": "2024-01-15T09:30:00Z",
378        "customer_external_id": "string",
379        "environment_id": "string",
380        "external_id": "string",
381        "id": "string",
382        "payment_method_type": "string",
383        "provider_type": "metronome",
384        "updated_at": "2024-01-15T09:30:00Z",
385        "account_last4": "string",
386        "account_name": "string",
387        "bank_name": "string",
388        "billing_email": "string",
389        "billing_name": "string",
390        "card_brand": "string",
391        "card_exp_month": 1,
392        "card_exp_year": 1,
393        "card_last4": "string",
394        "company_id": "string"
395      }
396    ],
397    "plans": [
398      {
399        "id": "string",
400        "name": "string",
401        "description": "string",
402        "image_url": "string"
403      }
404    ],
405    "rules": [
406      {
407        "account_id": "string",
408        "condition_groups": [
409          {
410            "conditions": [
411              {
412                "account_id": "string",
413                "condition_type": "base_plan",
414                "environment_id": "string",
415                "id": "string",
416                "operator": "eq",
417                "resource_ids": [
418                  "string"
419                ],
420                "trait_value": "string",
421                "comparison_trait_definition": {
422                  "comparable_type": "bool",
423                  "entity_type": "company",
424                  "id": "string"
425                },
426                "consumption_rate": 1.1,
427                "credit_id": "string",
428                "event_subtype": "string",
429                "metric_period": "all_time",
430                "metric_period_month_reset": "billing_cycle",
431                "metric_value": 1,
432                "trait_definition": {
433                  "comparable_type": "bool",
434                  "entity_type": "company",
435                  "id": "string"
436                }
437              }
438            ]
439          }
440        ],
441        "conditions": [
442          {
443            "account_id": "string",
444            "condition_type": "base_plan",
445            "environment_id": "string",
446            "id": "string",
447            "operator": "eq",
448            "resource_ids": [
449              "string"
450            ],
451            "trait_value": "string",
452            "comparison_trait_definition": {
453              "comparable_type": "bool",
454              "entity_type": "company",
455              "id": "string"
456            },
457            "consumption_rate": 1.1,
458            "credit_id": "string",
459            "event_subtype": "string",
460            "metric_period": "all_time",
461            "metric_period_month_reset": "billing_cycle",
462            "metric_value": 1,
463            "trait_definition": {
464              "comparable_type": "bool",
465              "entity_type": "company",
466              "id": "string"
467            }
468          }
469        ],
470        "environment_id": "string",
471        "id": "string",
472        "name": "string",
473        "priority": 1,
474        "rule_type": "company_override",
475        "value": true,
476        "flag_id": "string"
477      }
478    ],
479    "updated_at": "2024-01-15T09:30:00Z",
480    "user_count": 1,
481    "billing_credit_balances": {},
482    "billing_subscription": {
483      "cancel_at_period_end": true,
484      "created_at": "2024-01-15T09:30:00Z",
485      "currency": "string",
486      "customer_external_id": "string",
487      "discounts": [
488        {
489          "coupon_id": "string",
490          "coupon_name": "string",
491          "discount_external_id": "string",
492          "duration": "string",
493          "is_active": true,
494          "started_at": "2024-01-15T09:30:00Z",
495          "subscription_external_id": "string",
496          "amount_off": 1,
497          "currency": "string",
498          "customer_facing_code": "string",
499          "duration_in_months": 1,
500          "ended_at": "2024-01-15T09:30:00Z",
501          "percent_off": 1.1,
502          "promo_code_external_id": "string"
503        }
504      ],
505      "id": "string",
506      "interval": "string",
507      "period_end": 1,
508      "period_start": 1,
509      "products": [
510        {
511          "billing_scheme": "per_unit",
512          "created_at": "2024-01-15T09:30:00Z",
513          "currency": "string",
514          "environment_id": "string",
515          "external_id": "string",
516          "id": "string",
517          "interval": "string",
518          "name": "string",
519          "package_size": 1,
520          "price": 1,
521          "price_external_id": "string",
522          "price_id": "string",
523          "price_tier": [
524            {
525              "flat_amount": 1,
526              "per_unit_price": 1,
527              "per_unit_price_decimal": "string",
528              "up_to": 1
529            }
530          ],
531          "provider_type": "metronome",
532          "quantity": 1.1,
533          "subscription_id": "string",
534          "updated_at": "2024-01-15T09:30:00Z",
535          "usage_type": "licensed",
536          "billing_threshold": 1,
537          "interval_count": 1,
538          "meter_id": "string",
539          "price_decimal": "string",
540          "subscription_item_external_id": "string"
541        }
542      ],
543      "provider_type": "metronome",
544      "status": "string",
545      "subscription_external_id": "string",
546      "total_price": 1,
547      "application_id": "string",
548      "cancel_at": 1,
549      "company_id": "string",
550      "default_payment_method_id": "string",
551      "expired_at": "2024-01-15T09:30:00Z",
552      "latest_invoice": {
553        "amount_due": 1,
554        "amount_paid": 1,
555        "amount_remaining": 1,
556        "collection_method": "string",
557        "created_at": "2024-01-15T09:30:00Z",
558        "currency": "string",
559        "customer_external_id": "string",
560        "environment_id": "string",
561        "id": "string",
562        "provider_type": "metronome",
563        "subtotal": 1,
564        "updated_at": "2024-01-15T09:30:00Z",
565        "company_id": "string",
566        "due_date": "2024-01-15T09:30:00Z",
567        "external_id": "string",
568        "payment_method_external_id": "string",
569        "status": "draft",
570        "subscription_external_id": "string",
571        "url": "string"
572      },
573      "metadata": {},
574      "payment_method": {
575        "created_at": "2024-01-15T09:30:00Z",
576        "customer_external_id": "string",
577        "environment_id": "string",
578        "external_id": "string",
579        "id": "string",
580        "payment_method_type": "string",
581        "provider_type": "metronome",
582        "updated_at": "2024-01-15T09:30:00Z",
583        "account_last4": "string",
584        "account_name": "string",
585        "bank_name": "string",
586        "billing_email": "string",
587        "billing_name": "string",
588        "card_brand": "string",
589        "card_exp_month": 1,
590        "card_exp_year": 1,
591        "card_last4": "string",
592        "company_id": "string"
593      },
594      "trial_end": 1,
595      "trial_end_setting": "cancel"
596    },
597    "default_payment_method": {
598      "created_at": "2024-01-15T09:30:00Z",
599      "customer_external_id": "string",
600      "environment_id": "string",
601      "external_id": "string",
602      "id": "string",
603      "payment_method_type": "string",
604      "provider_type": "metronome",
605      "updated_at": "2024-01-15T09:30:00Z",
606      "account_last4": "string",
607      "account_name": "string",
608      "bank_name": "string",
609      "billing_email": "string",
610      "billing_name": "string",
611      "card_brand": "string",
612      "card_exp_month": 1,
613      "card_exp_year": 1,
614      "card_last4": "string",
615      "company_id": "string"
616    },
617    "last_seen_at": "2024-01-15T09:30:00Z",
618    "logo_url": "string",
619    "plan": {
620      "id": "string",
621      "included_credit_grants": [
622        {
623          "billing_credit_auto_topup_enabled": true,
624          "billing_credit_auto_topup_self_service": true,
625          "created_at": "2024-01-15T09:30:00Z",
626          "credit_amount": 1,
627          "credit_id": "string",
628          "id": "string",
629          "plan_id": "string",
630          "reset_type": "no_reset",
631          "rollover_percentage": 1,
632          "updated_at": "2024-01-15T09:30:00Z",
633          "credit_description": "string",
634          "credit_name": "string",
635          "billing_credit_auto_topup_amount": 1,
636          "billing_credit_auto_topup_amount_type": "string",
637          "billing_credit_auto_topup_expiry_type": "duration",
638          "billing_credit_auto_topup_expiry_unit": "billing_periods",
639          "billing_credit_auto_topup_expiry_unit_count": 1,
640          "billing_credit_auto_topup_threshold_credits": 1,
641          "billing_credit_auto_topup_threshold_percent": 1,
642          "company_auto_topup_amount": 1,
643          "company_auto_topup_enabled": true,
644          "company_auto_topup_threshold_credits": 1,
645          "credit": {
646            "account_id": "string",
647            "burn_strategy": "expiration_priority",
648            "cost_editable": true,
649            "created_at": "2024-01-15T09:30:00Z",
650            "currency_prices": [
651              {
652                "currency": "string",
653                "price": {
654                  "billing_scheme": "per_unit",
655                  "created_at": "2024-01-15T09:30:00Z",
656                  "currency": "string",
657                  "id": "string",
658                  "interval": "day",
659                  "interval_count": 1,
660                  "is_active": true,
661                  "package_size": 1,
662                  "price": 1,
663                  "price_external_id": "string",
664                  "price_id": "string",
665                  "price_tier": [
666                    {
667                      "flat_amount": 1,
668                      "per_unit_price": 1,
669                      "per_unit_price_decimal": "string",
670                      "up_to": 1
671                    }
672                  ],
673                  "product_external_id": "string",
674                  "product_id": "string",
675                  "product_name": "string",
676                  "provider_type": "metronome",
677                  "updated_at": "2024-01-15T09:30:00Z",
678                  "usage_type": "licensed",
679                  "meter_event_name": "string",
680                  "meter_event_payload_key": "string",
681                  "meter_id": "string",
682                  "nickname": "string",
683                  "price_decimal": "string",
684                  "tiers_mode": "graduated"
685                }
686              }
687            ],
688            "default_expiry_unit": "billing_periods",
689            "default_rollover_policy": "expire",
690            "description": "string",
691            "environment_id": "string",
692            "id": "string",
693            "ledger_authority": "schematic_authoritative",
694            "name": "string",
695            "updated_at": "2024-01-15T09:30:00Z",
696            "default_expiry_unit_count": 1,
697            "icon": "string",
698            "plural_name": "string",
699            "price": {
700              "billing_scheme": "per_unit",
701              "created_at": "2024-01-15T09:30:00Z",
702              "currency": "string",
703              "id": "string",
704              "interval": "day",
705              "interval_count": 1,
706              "is_active": true,
707              "package_size": 1,
708              "price": 1,
709              "price_external_id": "string",
710              "price_id": "string",
711              "price_tier": [
712                {
713                  "flat_amount": 1,
714                  "per_unit_price": 1,
715                  "per_unit_price_decimal": "string",
716                  "up_to": 1
717                }
718              ],
719              "product_external_id": "string",
720              "product_id": "string",
721              "product_name": "string",
722              "provider_type": "metronome",
723              "updated_at": "2024-01-15T09:30:00Z",
724              "usage_type": "licensed",
725              "meter_event_name": "string",
726              "meter_event_payload_key": "string",
727              "meter_id": "string",
728              "nickname": "string",
729              "price_decimal": "string",
730              "tiers_mode": "graduated"
731            },
732            "price_per_unit": 1,
733            "price_per_unit_decimal": "string",
734            "product": {
735              "account_id": "string",
736              "created_at": "2024-01-15T09:30:00Z",
737              "environment_id": "string",
738              "external_id": "string",
739              "is_active": true,
740              "name": "string",
741              "price": 1.1,
742              "product_id": "string",
743              "provider_type": "metronome",
744              "quantity": 1.1,
745              "updated_at": "2024-01-15T09:30:00Z",
746              "price_decimal": "string",
747              "currency": "string"
748            },
749            "singular_name": "string"
750          },
751          "expiry_type": "duration",
752          "expiry_unit": "billing_periods",
753          "expiry_unit_count": 1,
754          "plan": {
755            "id": "string",
756            "name": "string",
757            "description": "string",
758            "image_url": "string"
759          },
760          "plan_version_id": "string",
761          "reset_cadence": "daily",
762          "reset_start": "billing_period",
763          "credit_icon": "string",
764          "plural_name": "string",
765          "singular_name": "string"
766        }
767      ],
768      "name": "string",
769      "added_on": "2024-01-15T09:30:00Z",
770      "billing_product_external_id": "string",
771      "billing_product_id": "string",
772      "description": "string",
773      "image_url": "string",
774      "plan_period": "string",
775      "plan_price": 1,
776      "plan_version_id": "string"
777    },
778    "scheduled_downgrade": {
779      "currency": "string",
780      "effective_after": "2024-01-15T09:30:00Z",
781      "from_plan_id": "string",
782      "from_plan_name": "string",
783      "from_subscription_price": 1,
784      "id": "string",
785      "interval": "string",
786      "to_plan_id": "string",
787      "to_plan_name": "string",
788      "scheduled_interval": "string",
789      "scheduled_price": 1
790    },
791    "traits": {}
792  },
793  "params": {}
794}
Was this page helpful?
Previous

The User object

Next
Built with

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
keysmap from strings to stringsRequired

Key/value pairs to identify a company or user

traitstringRequired<=255 characters
Name of the trait to update
incrlong or nullOptional

Amount to increment the trait by (positive or negative)

setstring or nullOptional<=1024 characters
Value to set the trait to
update_onlyboolean or nullOptional
Unless this is set, the company or user will be created if it does not already exist

Response

OK
dataobject
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error