Skip to main content

Chargebee

ProsperStack integrates with Chargebee.

Connecting Chargebee​

To connect Chargebee, you'll need your Chargebee site name and API key.

Connect Chargebee

Site name — Your Chargebee site name is the first part of the URL in your Chargebee account. For example, if your site is accessed at https://acme.chargebee.com, your site name is acme. If you'd like to connect your test Chargebee site instead, append -test to the site name, for example acme-test.

API key — You can create a Chargebee API key by navigating to Settings → Configure Chargebee → API keys in your Chargebee account.

For more information on Chargebee API keys, see the Chargebee documentation.

After clicking Connect Chargebee, the import process will begin automatically.

Syncing Chargebee metadata​

Prosper planEnterprise plan

To use customer or subscription data stored in Chargebee metadata within ProsperStack, you can link metadata fields to custom properties.

Navigate to the Chargebee integration page by clicking Settings in the left navigation, then Integrations. Click Configure in the Chargebee section.

Chargebee metadata mappings

Configure new metadata mappings in the Property mappings section. Choose from either "Customer" or "Subscription" metadata, enter a Chargebee metadata field property in the text box, and choose a ProsperStack custom property (or create a new one) to link the metadata field to.

When creating a custom property in ProsperStack, make sure to choose an appropriate data type (text, number, etc.). Since Chargebee metadata values can be of any type, ProsperStack will attempt to convert the data to the type of custom property that the field is mapped to.

When you've configured your property mappings, click Save changes. ProsperStack will begin syncing your Chargebee metadata with your subscriber and subscription custom fields.