Manage Subscriptions via APIs
This article explains how to Manage Subscriptions via APIs. This will unlock the integration scenario in which you can collect subscription data and manage subscriptions in your ERP/CRM and/or marketplace.
APIs in scope:
No.1. List all Subscriptions
Get all subscriptions associated with the selected customer. The API will return both enabled and disabled subscriptions.
No.2. Retrieve a subscription
Get detailed information on the selected subscription.
No.2.1. List add-ons for subscription
Get detailed information about add-ons associated with a specific subscription. It eliminates the need for manual searching or querying multiple sources, enabling a streamlined process for retrieving add-on details. Details include:
- Id: A unique identifier for the addon subscription. Id is used as "SubscriptionId" when updating a subscription.
- OfferId: The identifier for the offer associated with the addon.
- Quantity: The quantity of the addon.
- SubscriptionState: The state of the subscription (e.g., Enabled, Disabled).
- Name: The name of the addon.
- MeterName: The meter name associated with the addon.
- MinAmount: The minimum quantity allowed for the addon.
- MaxAmount: The maximum quantity allowed for the addon.
- OfferType: The addon's offer type (e.g., LicenceBasedSubscription).
- IsOffer: Indicates whether the addon is an offer.
- IsCpq: Indicates whether the addon is subject to CPQ (Configure Price Quote) form. If true, you can retrieve a pricing plan for such an add-on by using "Retrieve a pricing plan for the offer".
- VendorId: The identifier for the vendor associated with the addon.
- OfferConfigurationType: The configuration type of the offer for the addon (e.g., ManualQuantityOnly).
No.3. Update a subscription
Updates a subscription based on the available configuration, including, but not limited to changing the subscription quantity, billing cycle (monthly, annual), and term.
Please note that offers can have different compatibility rules, post-purchase restrictions, and billing cycle settings. For example, for some offers, you are unable to reduce the quantity, or change the billing cycle, whereas others can be canceled only within a specific time frame. As a result, when you're building an integration please consider the individual offer logic specified in the offer pricing plan. The pricing plan can be retrieved by using Retrieve a pricing plan for the offer.