Custom Service Subscription Management API
Seller Level Operations
Use Case
Provides sellers APIs to manage subscriptions across their entire customer base, regardless of which reseller manages the relationship.
Guidlines
Seller level credentials will be required to access seller level APIs.
Operation | Method | API | Description |
|---|---|---|---|
Swagger: SellerSubscriptions | |||
List Subscriptions | GET | /api/sellers/{sellerId}/subscriptions | Returns all seller subscriptions. |
List by Service | GET | /api/sellers/{sellerId}/subscriptions/service/{serviceId} | Returns all subscriptions for a specific service across all resellers and organizations. |
Get Subscription | GET | /api/sellers/{sellerId}/subscriptions/{subscriptionId} | Returns details for a specific subscription. |
Cancel/Delete Subscription | DELETE | /api/sellers/{sellerId}/subscriptions/{subscriptionId} | Cancels or deletes a subscription. |
Set License Key | PUT | /api/sellers/{sellerId}/subscriptions/SetLicenseKey/{subscriptionId} | Assigns or updates a license key to a subscription. |
Reseller Level Operations
Use Case
Enables brokers to view all subscriptions for a specific custom service they manage.
Guidlines
Broker level credentials will be required to access broker level APIs.
Operation | Method | API | Description |
|---|---|---|---|
Swagger: ResellerServices | |||
List Subscriptions | GET | /api/resellers/{resellerId}/services/{serviceId}/subscriptions | Returns all subscriptions for a custom service across all organizations under the reseller. |
Organization Level Operations
Provides operations for custom service subscriptions at the organization level.
Guidlines
Broker level credentials will be required to access organization level APIs.
When creating subscriptions, use the unique product identifiers (productId) from the price lists: ResellerPriceList for reseller level pricing and OrganizationPriceList for organization specific pricing.
Operation | Method | API | Description |
|---|---|---|---|
Swagger: OrganizationServiceSubscriptions | |||
List Subscriptions | GET | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions | Retrieves all subscriptions for a custom service in an organization. |
Get Subscription | GET | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId} | Retrieves details for a specific subscription. |
Create Subscription | POST | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions | Provisions a new subscription for the organization. |
Update Subscription | PUT | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId} | Modifies subscription details. |
Cancel Subscription | DELETE | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId} | Cancels a subscription. |
Swagger: OrganizationSubscriptionHistory | |||
Get Subscription History | GET | /api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/Subscriptionshistory/{subscriptionId} | Retrieves an audit trail of changes to a subscription. |