Skip to content

Commit 702be5b

Browse files
Merge pull request #228786 from arifgani/docs-editor/pc-saas-fulfillment-subscripti-1677541500
Change listAvailable Plans
2 parents 886457a + 62a5bac commit 702be5b

File tree

1 file changed

+32
-43
lines changed

1 file changed

+32
-43
lines changed

articles/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api.md

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -357,15 +357,14 @@ This API retrieves all plans for a SaaS offer identified by the `subscriptionId`
357357

358358
This call returns a list of plans available for that customer in addition to the one already purchased. The list can be presented to an end user on the publisher site. An end user can change the subscription plan to any one of the plans in the returned list. Changing the plan to one not in the list will fail.
359359

360-
### Get `https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/listAvailablePlans?api-version=<ApiVersion>&planId=<planId>`
360+
### Get `https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/listAvailablePlans?api-version=<ApiVersion>`
361361

362362
*Query parameters:*
363363

364364
| Parameter | Value |
365365
| --------------- | --------------- |
366366
| `ApiVersion` | Use 2018-08-31. |
367367
| `subscriptionId` | The unique identifier of the purchased SaaS subscription. This ID is obtained after resolving the commercial marketplace authorization token by using the Resolve API. |
368-
| `planId` (Optional) |Pass planId if you want to filter the response to this plan only. |
369368

370369
*Request headers:*
371370

@@ -384,49 +383,35 @@ Returns a list of all available plans for an existing SaaS subscription includin
384383
Response body example:
385384

386385

387-
```json
388386

387+
388+
389+
390+
```json
389391
{
390-
"plans": [
391-
{
392-
"planId": "string",
393-
"displayName": "string",
394-
"isPrivate": "bool",
395-
"description": "string",
396-
"minQuantity": "int",
397-
"maxQuantity": "int",
398-
"hasFreeTrials": "bool",
399-
"isPricePerSeat": "bool",
400-
"isStopSell": "bool",
401-
"market": "string",
402-
"planComponents": {
403-
"recurrentBillingTerms": [
404-
{
405-
"currency": "string",
406-
"price": "decimal",
407-
"termUnit": "string",
408-
"termDescription": "string",
409-
"meteredQuantityIncluded": [
410-
{
411-
"dimensionId": "string",
412-
"units": "string"
413-
}
414-
]
415-
}
416-
],
417-
"meteringDimensions": [
418-
{
419-
"id": "string",
420-
"currency": "string",
421-
"pricePerUnit": "decimal",
422-
"unitOfMeasure": "string",
423-
"displayName": "string"
424-
}
425-
]
426-
}
427-
}
428-
]
429-
}
392+
"planId": "Platinum001",
393+
"displayName": "Private platinum plan for Contoso", // display name of the plan as it appears in the marketplace
394+
"isPrivate": true, //true or false
395+
"description": "plan description",
396+
"minQuantity": 5,
397+
"maxQuantity": 100,
398+
"hasFreeTrials": false,
399+
"isPricePerSeat": true,
400+
"isStopSell": false,
401+
"market": "US",
402+
},
403+
{
404+
"planId": "gold",
405+
"displayName": "Gold plan for Contoso",
406+
"isPrivate": false, //true or false
407+
"description": "gold plan details.",
408+
"minQuantity": 1,
409+
"maxQuantity": 5,
410+
"hasFreeTrials": false,
411+
"isPricePerSeat": true,
412+
"isStopSell": false,
413+
"market": "US",
414+
}
430415

431416
```
432417

@@ -644,3 +629,7 @@ See the [commercial marketplace metering service APIs](../marketplace-metering-s
644629
Review and use the [clients for different programming languages and samples](https://github.com/microsoft/commercial-marketplace-samples).
645630

646631

632+
633+
634+
635+

0 commit comments

Comments
 (0)