The field object

A field is a key a filter’s comparison or a breakdown’s dimension may name: a field a record carries, a property a source wrote, or a dimension of the run rate movements themselves.

Attributes

• idstring

  The key, as a filter or a breakdown names it: customer.first_paying_at, subscription.properties.stripe.plan_tier, movement_type.

• objectstring

  The object’s type, always field.

  Always field

• at_supportedboolean

  Whether a comparison or a dimension naming it may say at — when the value is read: the end of each period, now, or a datetime. A dimension of the run rate movements themselves takes none.

• breakdown_supportedboolean

  Whether a dimension in a breakdown may name it.

• filter_supportedboolean

  Whether a comparison in a filter may name it.

• labelstring

  What to call it: First Paying At, Plan, or the name a property goes by.

• originenum

  Where its value comes from: exclusive, a field only the source a subscription lives in may write; promoted, a customer’s field any source may write, taken from the highest-ranked source that has one; derived, one Summerbase works out; property, what one source has written about the record; or run_rate_movement, a dimension of the revenue movements themselves.

  One of exclusive, promoted, derived, property, run_rate_movement

• promotedboolean

  Whether the key is resolved across sources onto the record. For a property, the record field of the same name carries the resolved value: customer.properties.stripe.name is what Stripe said, and customer.name is the answer.

• referencesenum

  What each value is the id of, for a field whose values name something: country for a country code, currency for a currency code, plan for a plan id. Absent for a field holding values of its own.

  One of country, currency, plan, price

• source_slugstring

  For a property, the source that wrote it. Absent otherwise.

• subject_typestring

  What it is about: customer, subscription, subscription_item, or run_rate_movement for a dimension of the run rate movements themselves.

• value_typestring

  What it holds: string, number, boolean or datetime. A breakdown by a datetime field says which unit to truncate to, and one by a number may give boundaries, or ask for them with auto.

Example

{
  "at_supported": true,
  "breakdown_supported": true,
  "filter_supported": true,
  "id": "customer.first_paying_at",
  "label": "First Paying At",
  "object": "field",
  "origin": "derived",
  "promoted": false,
  "references": null,
  "source_slug": null,
  "subject_type": "customer",
  "value_type": "datetime"
}

Endpoints

• GET/v1/fieldsList fields