Broker Level Operations
Use Case
Provides a consolidated view of all Microsoft CSP 365 subscriptions which could be used to create, update or track Microsoft CSP 365 subscriptions.
Key Concepts
-
itemCode: Unique identifier for NCE products
Guidelines
-
Cloudmore synchronizes subscription changes made in Microsoft Partner Center once per day; updates made in Partner Center appear after the next daily sync completes.
-
Avoid high‑frequency polling; for example, every 15 minutes which will generally return unchanged data.
-
Subscription upgrades are processed asynchronously; initiate the upgrade, then check the upgrade status.
-
When creating subscriptions, use the unique product identifiers (itemCode) from the price lists: ResellerPriceList for reseller level pricing and OrganizationPriceList for organization specific pricing.
|
Operation |
Method |
API |
Description |
|---|---|---|---|
|
Swagger: ResellerCspNceSubscriptions |
|||
|
List Subscriptions |
GET |
/api/resellers/{resellerId}/services/csp/nce/subscriptions |
Returns all NCE subscriptions across all organizations for a broker. |
Organization Level Operations
|
Operation |
Method |
API |
Description |
|---|---|---|---|
|
Swagger: OrganizationCspSubscriptionsNce |
|||
|
List Subscriptions |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions |
Returns all NCE subscriptions for an organization. |
|
Get Subscription |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{id} |
Returns details for a specific subscription. |
|
Create Subscription |
POST |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions |
Provisions a new NCE subscription. |
|
Update Subscription |
PUT |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId} |
Modifies subscription name, quantity, purchase order number, sales price or billing visibility. |
|
Delete Subscription |
DELETE |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId} |
Cancels a subscription. |
Advanced Operations:
|
Operation |
Method |
API |
Description |
|---|---|---|---|
|
Get New Subscription Eligibility |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId}/newSubscriptionEligibilities |
Returns all available products with the itemCodes that can be used for upgrading a subscription. |
|
Get Existing Subscription Eligibility |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId}/existingSubscriptionEligiblities |
Returns all available upgradable subscriptions to an existing subscription. |
|
Upgrade to New Subscription |
POST |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId}/upgradeToNewSubscription |
Upgrades a current subscription to a different product (creates new subscription). |
|
Upgrade to Existing Subscription |
POST |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId}/upgradeToExistingSubscription |
Merges current subscription into an existing subscription. |
|
Check Upgrade Status |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/{subscriptionId}/upgradeStatus |
Monitors the status of an upgrade. |
|
Get Alignment Dates |
GET |
/api/resellers/{resellerId}/organizations/{organizationId}/services/csp/nce/subscriptions/alignmentdates |
Retrieves available term alignment dates for subscription creation by term duration. |