Skip to content

Properties

Properties are what a source knows about a record beyond its own fields: a customer’s seat count, a subscription’s account manager. Customers, subscriptions, subscription items, prices and plans all take them, as properties on a write:

{"properties": {"seats": 25, "plan_tier": "growth", "trial_extended": true}}
  • Each source’s properties are its own. properties on a record is your source’s, and properties_by_source holds every source’s, keyed by source slug. A write reaches only your source’s.
  • A key is registered the first time it is written, and a value is a string, a number, a boolean or a datetime. The first value decides the type, unless the key was declared first with POST /v1/property_definitions.
  • Only the keys a write names change. null clears one.
  • A value may also be an object: {"value": "2026-01-01T00:00:00Z", "type": "datetime"} states its type, and "operation" may be increment to add to a number or set_once to keep a value already there.

A value that does not fit its key’s type is skipped, with a warning; see Warnings.