Merge pull request #190940 from dannyevers/57262-saas-2

57262-saas-2

Author: v-regandowner

articles/marketplace/partner-center-portal/media/saas-update-api-v2-calls-from-saas-service-a.png

@@ -4,7 +4,7 @@ description: Learn how to manage the SaaS subscription life cycle by using the f
 ms.service: marketplace
 ms.subservice: partnercenter-marketplace-publisher
 ms.topic: reference
-ms.date: 10/27/2021
+ms.date: 03/07/2022
 author: arifgani
 ms.author: argani
 ---
@@ -35,7 +35,7 @@ An example of such call is `https://contoso.com/signup?token=<blob>`, but the la
 > [!IMPORTANT]
 > The landing page URL must be up and running all day, every day, and ready to receive new calls from Microsoft at all times. If the landing page becomes unavailable, customers won't be able to sign up for the SaaS service and start using it.
 
-Next, the publisher must pass the *token* back to Microsoft by calling the [SaaS Resolve API](pc-saas-fulfillment-subscription-api.md#resolve-a-purchased-subscription), and entering the token as the value of the `x-ms-marketplace-token header` header parameter. As the result of the Resolve API call, the token is exchanged for details of the SaaS purchase such as the unique ID of the purchase, purchased offer ID, and purchased plan ID.
+Next, the publisher must pass the *token* back to Microsoft by calling the [SaaS Resolve API](pc-saas-fulfillment-subscription-api.md#resolve-a-purchased-subscription), and entering the token as the value of the `x-ms-marketplace-token header` parameter. As the result of the Resolve API call, the token is exchanged for details of the SaaS purchase such as the unique ID of the purchase, purchased offer ID, and purchased plan ID.
 
 On the landing page, the customer should be signed in to the new or existing SaaS account via Azure Active Directory (Azure AD) single sign-on (SSO).
 
@@ -50,7 +50,7 @@ The publisher should implement SSO to provide the user experience required by Mi
 After sign in, the customer should complete the SaaS configuration on the publisher side. Then the publisher must call the [Activate Subscription API](pc-saas-fulfillment-subscription-api.md#activate-a-subscription) to send a signal to Azure Marketplace that the provisioning of the SaaS account is complete.
 This action will start the customer's billing cycle. If the Activate Subscription API call is not successful, the customer isn't billed for the purchase.
 
-![Diagram showing the A P I calls for a provisioning scenario.](./media/saas-update-api-v2-calls-from-saas-service-a.png) 
+[ ![Diagram showing the A P I calls for a provisioning scenario.](./media/saas-update-api-v2-calls-from-saas-service-a.png) ](./media/saas-update-api-v2-calls-from-saas-service-a.png#lightbox)
 
 ### Active (*Subscribed*)
 

articles/marketplace/partner-center-portal/pc-saas-fulfillment-life-cycle.md

@@ -4,7 +4,7 @@ description: Learn how to use the Operations APIs, which are part of the SaaS Fu
 ms.service: marketplace
 ms.subservice: partnercenter-marketplace-publisher
 ms.topic: reference
-ms.date: 11/10/2021
+ms.date: 03/07/2022
 author: arifgani
 ms.author: argani
 ---
@@ -27,7 +27,7 @@ Get list of the pending operations for the specified SaaS subscription. The publ
 |    `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.  |
 
 *Request headers:*
- 
+
 |  Parameter         | Value             |
 |  ---------------   |  ---------------  |
 |  `content-type`     |  `application/json` |
@@ -52,7 +52,7 @@ Returns pending operations on the specified SaaS subscription.
       "offerId": "offer1", // purchased offer ID
       "publisherId": "contoso",
       "planId": "silver", // purchased plan ID
-      "quantity": "20", // purchased amount of seats, will be empty is not relevant
+      "quantity": 20, // purchased amount of seats, will be empty is not relevant
       "action": "Reinstate",
       "timeStamp": "2018-12-01T00:00:00", // UTC
       "status": "InProgress" // the only status that can be returned in this case
@@ -118,7 +118,7 @@ Response body:
   "offerId": "offer1", // purchased offer ID
   "publisherId": "contoso",
   "planId": "silver", // purchased plan ID
-  "quantity": "20", // purchased amount of seats
+  "quantity": 20, // purchased amount of seats
   "action": "ChangePlan", // Can be ChangePlan, ChangeQuantity or Reinstate
   "timeStamp": "2018-12-01T00:00:00", // UTC
   "status": "InProgress", // Possible values: NotStarted, InProgress, Failed, Succeeded, Conflict (new quantity / plan is the same as existing)

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

@@ -4,7 +4,7 @@ description: Learn how to use the Subscription APIs, which are part of the  the
 ms.service: marketplace
 ms.subservice: partnercenter-marketplace-publisher
 ms.topic: reference
-ms.date: 12/08/2021
+ms.date: 03/07/2022
 author: arifgani
 ms.author: argani
 ---
@@ -77,13 +77,16 @@ Response body example:
     "planId": "silver",
     "term": {
       "termUnit": "P1M",
-      "startDate": "2019-05-31",
-      "endDate": "2019-06-29"
+      "startDate": "2022-03-07T00:00:00Z",
+      "endDate": "2022-04-06T00:00:00Z"
     },
-    "isTest": true,
+      "autoRenew": true/false,
+    "isTest": true/false,
     "isFreeTrial": false,
     "allowedCustomerOperations": ["Delete", "Update", "Read"],
-    "sandboxType": "None",
+      "sandboxType": "None",
+      "lastModified": "0001-01-01T00:00:00",
+      "quantity": 5,
     "sessionMode": "None"
   }
 }
@@ -129,18 +132,18 @@ After the SaaS account is configured for an end user, the publisher must call th
 ```json
 {  // needed for validation of the activation request
   "planId": "gold", // purchased plan, cannot be empty
-  "quantity": "" // purchased number of seats, can be empty if plan is not per seat
+  "quantity": "3" // purchased number of seats, can be empty if plan is not per seat
 }
 ```
 
 *Response codes:*
 
-Code: 200 
+Code: 200
 The subscription was marked as Subscribed on the Microsoft side.
 
 There is no response body for this call.
 
-Code: 400 
+Code: 400
 Bad request: validation failed.
 
 * `planId` doesn't exist in request payload.
@@ -185,7 +188,7 @@ The API returns paginated results of 100 per page.
 
 *Response codes:*
 
-Code: 200 
+Code: 200
 Returns the list of all existing subscriptions for all offers made by this publisher, based on the publisher's authorization token.
 
 *Response body example:*
@@ -199,24 +202,25 @@ Returns the list of all existing subscriptions for all offers made by this publi
       "publisherId": "contoso", // publisher ID
       "offerId": "offer1", // purchased offer ID
       "planId": "silver", // purchased plan ID
-      "quantity": "10", // purchased amount of seats, will be empty if plan is not per seat
+      "quantity": 10, // purchased amount of seats, will be empty if plan is not per seat
       "beneficiary": { // email address, user ID and tenant ID for which SaaS subscription was purchased.
         "emailId": " [email protected]",
         "objectId": "<guid>",
         "tenantId": "<guid>",
-        "pid": "<ID of the user>"
+        "puid": "<ID of the user>"
       },
       "purchaser": { // email address, user ID and tenant ID that purchased the SaaS subscription. These could be different from beneficiary information for reseller (CSP) purchase
         "emailId": " [email protected]",
         "objectId": "<guid>",
         "tenantId": "<guid>",
-        "pid": "<ID of the user>"
+        "puid": "<ID of the user>"
       },
       "term": { // The period for which the subscription was purchased.
-        "startDate": "2019-05-31", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is relevant only for Active and Suspended subscriptions.
-        "endDate": "2019-06-30", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew will happen the next day. This field is relevant only for Active and Suspended subscriptions.
+        "startDate": "2022-03-04T00:00:00Z", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is relevant only for Active and Suspended subscriptions.
+        "endDate": "2022-04-03T00:00:00Z", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew will happen the next day. This field is relevant only for Active and Suspended subscriptions.
         "termUnit": "P1M" // where P1M is monthly and P1Y is yearly. Also reflected in the startDate and endDate values
       },
+      "autoRenew": true,
       "allowedCustomerOperations": ["Read", "Update", "Delete"], // Indicates operations allowed on the SaaS subscription for beneficiary. For CSP-initiated purchases, this will always be "Read" because the customer cannot update or delete subscription in this flow.  Purchaser can perform all operations on the subscription.
       "sessionMode": "None", // not relevant
       "isFreeTrial": true, // true - the customer subscription is currently in free trial, false - the customer subscription is not currently in free trial. (Optional field -– if not returned, the value is false.)
@@ -249,6 +253,7 @@ Returns the list of all existing subscriptions for all offers made by this publi
         "endDate": "2020-04-30",
         "termUnit": "P1Y"
       },
+      "autoRenew": false
       "allowedCustomerOperations": ["Read"],
       "sessionMode": "None",
       "isFreeTrial": false,
@@ -307,28 +312,31 @@ Returns details for a SaaS subscription based on the `subscriptionId` provided.
   "publisherId": "contoso", // publisher ID
   "offerId": "offer1", // purchased offer ID
   "planId": "silver", // purchased plan ID
-  "quantity": "10", // purchased amount of seats, will be empty if plan is not per seat
+  "quantity": 10, // purchased amount of seats, will be empty if plan is not per seat
   "beneficiary": { // email address, user ID and tenant ID for which SaaS subscription is purchased.
     "emailId": "[email protected]",
     "objectId": "<guid>",
     "tenantId": "<guid>",
-    "pid": "<ID of the user>"
+    "puid": "<ID of the user>"
   },
   "purchaser": { // email address ,user ID and tenant ID that purchased the SaaS subscription.  These could be different from beneficiary information for reseller (CSP) scenario
     "emailId": "[email protected]",
     "objectId": "<guid>",
     "tenantId": "<guid>",
-    "pid": "<ID of the user>"
+    "puid": "<ID of the user>"
   },
   "allowedCustomerOperations": ["Read", "Update", "Delete"], // Indicates operations allowed on the SaaS subscription for beneficiary.  For CSP-initiated purchases, this will always be "Read" because the customer cannot update or delete subscription in this flow.  Purchaser can perform all operations on the subscription.
   "sessionMode": "None", // not relevant
   "isFreeTrial": false, // true - the customer subscription is currently in free trial, false - the customer subscription is not currently in free trial. Optional field – if not returned the value is false.
+  "autoRenew": true,
   "isTest": false, // not relevant
   "sandboxType": "None", // not relevant
+  "created": "2022-03-01T22:59:45.5468572Z",
+     "lastModified": "0001-01-01T00:00:00",
   "saasSubscriptionStatus": " Subscribed ", // Indicates the status of the operation: PendingFulfillmentStart, Subscribed, Suspended or Unsubscribed.
   "term": { // the period for which the subscription was purchased
-    "startDate": "2019-05-31", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is relevant only for Active and Suspended subscriptions.
-    "endDate": "2019-06-29", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew will happen the next day. This field is relevant only for Active and Suspended subscriptions.
+    "startDate": "2022-03-04T00:00:00Z", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is relevant only for Active and Suspended subscriptions.
+    "endDate": "2022-04-03T00:00:00Z", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew will happen the next day. This field is relevant only for Active and Suspended subscriptions.
     "termUnit": "P1M" //where P1M is monthly and P1Y is yearly. Also reflected in the startDate and endDate values.
   }
 }
@@ -383,11 +391,25 @@ Response body example:
       "planId": "Platinum001",
       "displayName": "Private platinum plan for Contoso", // display name of the plan as it appears in the marketplace
       "isPrivate": true //true or false
+      "description": "plan description",
+          "minQuantity": 5,
+          "maxQuantity": 100,
+          "hasFreeTrials": false,
+          "isPricePerSeat": true,
+          "isStopSell": false,
+          "market": "US",
     },
     {
       "planId": "gold",
       "displayName": "Gold plan for Contoso",
-      "isPrivate": false //true or false
+      "isPrivate": false //true or false,
+      "description": "gold plan details.",
+          "minQuantity": 1,
+          "maxQuantity": 5,
+          "hasFreeTrials": false,
+          "isPricePerSeat": true,
+          "isStopSell": false,
+          "market": "US",
     }
   ]
 }