The property definition object

A property definition says what a property key holds: the kind of record it describes, the type of its values, and the source that writes it. A key registers itself when it is first written; declare it ahead of that to settle its type first.

Attributes

idstring (UUID)
The property definition’s unique identifier.
objectstring
The object’s type, always property_definition.

Always property_definition
archivedboolean
Whether the key has stopped being offered. Its values stay and still read back.
created_attimestamp
When the key was first seen.
keystring
The key, as written. Immutable once it exists.
labelstring
What a screen calls this property: the name the source that owns it gave it, or the key in words — deal_stage is Deal Stage.
sourceobject
The source whose namespace this key lives in. Expandable.
Show 18 child attributes
- idstring (UUID)
  The source’s unique identifier. Records are identified by its slug.
- objectstring
  The object’s type, always source.
  
  Always source
- connected_attimestamp
  When a provider source was given its credential, or empty: a provider source that has not been connected yet or has been disconnected, and every source that is not a provider’s.
- created_attimestamp
  When the source was added.
- import_failed_attimestamp
  When the last import gave up, or empty when none has since the last one succeeded. The source’s log says why.
- import_progressdecimal string
  How far the running import has got, from 0 to 1, or empty while it does not know yet.
- import_started_attimestamp
  When the import now running began, or empty when none is. Every metric that reads this source’s records is incomplete until it ends.
- import_stepstring
  What the running import is doing, in a sentence: Importing customers, 1,240 of 8,100.
- imported_attimestamp
  When the last import finished, or empty when none has.
- namestring
  What the source is called, for people reading a screen.
- priorityinteger
  Where this source sits when resolving name and email. Lower wins, and the project’s own source starts at the top so a manual correction outranks a provider sync. It orders nothing else — every other property is namespaced by source and never arbitrated.
- project_idstring (UUID)
  The project the source belongs to.
- provider_account_idstring
  The provider’s own id for the account the source is connected to: acct_… for Stripe. Kept through a disconnect, so that connecting again is checked against it.
- provider_codeenum
  The code of the system the source pulls from. custom is a source you write to yourself, and the only one that accepts writes; stripe is connected with connect_stripe and fetches for itself.
  
  One of custom, stripe, summerbase
- sandboxboolean
  Whether the connection is to the provider’s test mode rather than a live account; empty while nothing is connected.
- slugstring
  How this source’s records are identified — the stripe in stripe:cus_123. Lowercase letters, digits, hyphens and underscores; unique within the project and fixed once the source exists, because integrations hard-code it. A reference shaped like an id is read as one, so a slug may not look like a UUID.
- webhook_installed_attimestamp
  When the provider’s webhook was installed for this source — by the connection, or by hand and registered with register_stripe_webhook — or empty: nothing is connected, or the source is connected without a webhook and its changes arrive with the hourly reconcile.
- webhook_urlstring
  Where the provider posts this source’s events: the address of the endpoint a connection installs, and of one to install by hand. Empty for a source whose provider posts no webhooks.
source_idstring (UUID)
The source whose namespace this key lives in.
subject_typeenum
What kind of record this key describes.

One of customer, subscription, subscription_item, plan, price
value_typeenum
What values of this key hold, fixed by the first one written.

One of string, number, boolean, datetime

Example

{
  "archived": false,
  "created_at": "2026-02-11T09:20:13Z",
  "id": "0198f1a5-7a8b-7c9d-8e0f-1a2b3c4d5e6f",
  "key": "seats",
  "label": "Seats",
  "object": "property_definition",
  "source_id": "0198f1a3-0c18-7d93-a6e2-1b4f9d7c3a58",
  "subject_type": "customer",
  "value_type": "number"
}

The property definition object

Attributes

Example

Endpoints