Before you begin integrating the Subscription API, ensure the following prerequisites are in place:

1. Configure Subscription Products

Set up your subscription products in one of the following tools:

• Commerce Assistant
• Subscription Commerce Manager

2. Define Upgrade and Downgrade Relationships

To support subscription upgrades and downgrades, you must define which subscription products can replace others based on your business rules.

You can configure these relationships in one of two ways:

3. Request API Access

Access to the Subscription API is restricted for security reasons.

To request access, contact Client Experience and provide the required technical information.

4. Set Up Your Integration

Your technical team should build an integration that supports both Cleverbridge and your internal systems.

Update Subscription Data in Cleverbridge

Use the Subscription API to perform subscription-related actions, such as:

• Changing subscription properties
• Processing upgrades or downgrades
• Managing subscription items

Synchronize Changes with Internal Systems

Any subscription changes made through the Subscription API should also be reflected in your internal systems.

📘

Example

• If a subscription is downgraded from 20 users to 10 users, your system should adjust the customer's access accordingly.
• If a customer adds an item to a multi-item subscription, your system should provision the additional service or entitlement.

5. Notify Cleverbridge

Before implementing your integration, notify Client Experience.

Early communication helps ensure smooth coordination and support throughout the integration process.

Next Steps

After completing the prerequisites, review the documentation for your specific use case:

Most common use cases