Skip to main content

Custom properties

Prosper planEnterprise plan

Custom properties can be used to build segments based on additional data stored on a subscription or subscriber.

To manage your custom properties, click the gear icon in the main navigation and then click the Properties tab.

Creating a property​

From the Properties screen, click Create a property.

Create a new custom property

Enter a name and unique identifier for your new property. The unique identifier is used by developers when integrating the flow and can't be changed after the property is created. A default value for the unique identifier will be generated for you if you don't specify one.

Choose to assign your new property to either the Subscriber or Subscription object type.

The available data types for custom properties are:

  • Text
  • Number
  • True or false (boolean)
  • Date

Any data you store in a custom property will be validated based on the chosen data type. Click Save to create the property.

Number formats​

Number properties have an additional option for controlling the formatting when displaying the property value. Formatting only applies when the property value is displayed and does not affect how the value is used in segments.

Property number formatting
  • Unformatted — Displayed unformatted, e.g. "10000"
  • Formatted — Formatted with commas, e.g. "100,000"
  • Currency — Formatted as a currency value, e.g. "$100,000.00"

Formatting data for custom properties​

Some of the data types for custom properties expect values to be in a certain format in order to be stored correctly.

  • True or false (boolean)

    When passing boolean values via JavaScript or JSON, use a JavaScript boolean value (true or false).

    If you're sending data to a custom property from an integration that doesn't support boolean values (like Stripe metadata), you can use the following text values:

    • true — "true", "t" or "1"
    • false — "false", "f" or "0"

    Note that a blank text value will be converted to false and any other non-blank text value will be converted to true.

  • Dates

    Date values should be in ISO 8601 format, for example "1983-06-16".

Changing a property's type​

You can change the type of an existing property from its edit panel. ProsperStack attempts to convert existing values to the new type. Any value that cannot be converted is permanently deleted, and this cannot be undone.

After selecting the new type and clicking Save, enter CONTINUE in the confirmation field and click Convert property.

Review existing values before converting

Property type conversion can permanently remove values that are incompatible with the new type. Export or otherwise preserve any data you may need before confirming the conversion.

Archiving or permanently deleting a property​

Open a property and click Delete to choose how it should be removed:

  • Archive property makes the property unavailable for future use but keeps its existing subscriber or subscription values.
  • Permanently delete removes the property and all of its stored values. This cannot be undone.

To permanently delete the property, click Permanently delete, enter DELETE in the confirmation field and click Permanently delete again.

Populating custom properties from integrations​

In addition to setting custom property values directly in the flow, certain integrations can populate custom properties automatically. When a flow session starts, ProsperStack looks up the subscriber in the connected service and writes the mapped values onto the subscriber.

The following integrations support automatic property population:

  • Yotpo — Maps fields from a customer's Yotpo loyalty record (points balance, VIP tier, store credit, referral activity and enrollment status) to custom properties. Configure field mappings from Settings → Integrations → Yotpo. Learn more.

Using custom properties​

Learn how to provide custom property values in the cancellation flow.