Overview
The Cloudmore API is a RESTful API that Cloudmore customers can use to order and manage services and subscriptions, as well as retrieve billing information.
The Cloudmore API enables the automation of routine tasks such as:
-
Retrieve service and product information to display in their online portals.
-
Create customers and users in Cloudmore and external cloud services.
-
Create subscriptions for different services and assign subscriptions to users.
-
Suspend, cancel, and delete subscriptions.
-
Configure and update pricing for products and set customer-specific prices.
-
Retrieve billing information to integrate with external ERP and financial reporting systems.
This API documentation explains how to access the Cloudmore API and includes examples to help you get started. Work through it in order: Getting started with APIs to request access and create an API user, Authentication to get an access token, and Making API requests to build requests, read responses and handle status codes.
For more details about the API documentation, refer to the Swagger Documentation.
Most common API use cases
Organization Management
The Organizations API in Cloudmore enables integration with ERP or CRM systems. It keeps customer data synchronized and up to date across platforms. This reduces manual data entry and improves operational efficiency. Ideal for businesses seeking streamlined system connectivity.
The API Guide for Organization Management provides additional information.
User Management
The User management API helps in automating user creation, with Cloudmore’s Users API simplifies access management across your organization. It streamlines employee onboarding and offboarding by automatically granting or revoking platform access, and enables automatic creation of Organization Admin users during customer onboarding.
The API Guide for User Management provides additional information.
Service Integration
Cloudmore’s flexible platform allows external services to be integrated and showcased in its marketplace. When setting up a service, you can choose between triggering an email for a quick and simple start or initiating a webhook call for full automation. Webhook integration requires a Cloudmore Service Connector, which acts as middleware to relay and translate communications between Cloudmore and the external service, enabling seamless end-to-end provisioning.
The API Guide for Service Integration provides additional information.
Metered Subscriptions Automation
The metered subscriptions automation is about how Cloudmore manages metered subscriptions, where billing is based on actual usage rather than licenses. Consumption data must be submitted for each customer, triggering automatic billing typically in arrears for the previous period. It also outlines how to automate data submission to ensure accurate and timely billing.
The API Guide for Metered Subscriptions Automation provides detailed information.
Price Management
Cloudmore Price Management APIs enable automated updates to global or customer-specific pricing, ensuring timely and accurate adjustments. By integrating these APIs into your pricing workflow, you can maintain profitability, prevent margin erosion, and support scalable, responsive pricing strategies across services and customer segments.
The API Guide for Price Management provides additional information.
Billing Integration
Cloudmore Billing APIs support seamless billing integration with ERP or financial systems, typically requiring just one API call to retrieve monthly billing data. Billing dates vary by service—for example, Microsoft NCE data is available between the 6th and 8th, while legacy services follow partner-specific schedules. For most organizations, retrieving billing data once or twice a month is sufficient for accurate processing.
The API Guide for Billing Integration provides additional information.