Skip to main content

Metadata

Through Stripe's dashboard, you can configure metadata for each product and price.

Connhex Pay defines a format for these objects: by following it, you're ensuring users can access product information directly from their profile.

Optional

All metadata are optional and independent of one another - set none, every or just the ones you need.

Product metadata​

Products should have the metadata field defined as follows:

{
  realm: string;
  features_url: string;
  compatibility_mode: 'none' | 'all';
}

where:

  • realm: defines what realm the product belongs to. Use this if you want to only show products belonging to a given realm during the checkout flows in the same realm.
  • features_url: a link to a list of product features (typically the product's feature page). This link will appear in the product card during the plan selection flow:
  • compatibility_mode: specify whether this product can be purchased together with all of the other products in the same realm or can only be bought alone (none).

FAQ​

Why do I need a separate features page?​

Also phrased as "Can't I just add a list of JSON objects and have those rendered inside a pricing card?".

Having a separate features page allows your marketing and product teams to have a single source of truth for plans and prices. You shouldn't need to update the profile application if you just want to change a few words on a pricing plan copy, for example.

If I make a pricing change on my website, will this be reflected automatically on Connhex?​

It depends on what your changes are:

  • if you're just changing the wording on some copy, you don't need to update anything else
  • if you're changing the price itself, make sure you update Stripe's pricing through your dashboard. Then Connhex will automatically sync
  • if you're changing what features are accessible from a given pricing plan, you need to update the permissions map through Connhex Control.