Get Product History

Updated on 16 Jul 2023
1 Minute to read

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Get subscription history for products in last 90 days

URL

GET https://contoso-prod-api.azurewebsites.net/api/SubscriptionHistory/report

Request headers

Key	Value
Authorization	Bearer <access_token>
Content-Type	Application/json

Request body

The request doesn’t require any parameters / body

Response body

An example response for the request to get active customers is as follows:

{

    "OperationType": null,

    "Status": "Success",

    "RequestCorrelationID": "08deaa5f-b2b7-4087-a2bb-add8344e444e",

    "ErrorMessage": null,

    "ErrorDetail": null,

    "Data": [

        {

            "CustomerId": "656DF20A-3456-6788-BCCE-1D9D963E7979",

            "CustomerName": "Contoso",

            "TenantId": "1234F20A-3456-8765-BCCE-1D9D96F567899",

            "EntityName": "Customer",

            "LinkedTenantName": " Contoso ",

            "ProductName": "Visio Plan 2",

            "OldQuantity": 2,

            "NewQuantity": 2,

            "DateofChange": "2022-09-20T16:26:26.663",

            "OldStatus": "Active",

            "NewStatus": "Active",

            "OldPrice": 15.0000,

            "NewPrice": 15.0000,

            "CreatedBy": "john.doe@contoso.com",

            "OwnerName": " Contoso "

        },

Here is the explanation for the properties in the response (JSON)

Property

Description

OperationType

Can be ignored

Status

Indicates the status of the request. Possible values – Success / Error

RequestCorrelationID

Internal ID generated by C3 for correspondence for troubleshooting issues, if any.

ErrorMessage

Message in case the request runs into an error during processing

ErrorDetail

Additional detail related to the error in case there is an error while processing the request

Data

Contains a list of customer objects represented by the following attributes:

Attribute	Description
CustomerId	Unique identifier for the customer in C3
CustomerName	Name of customer
TenantId	Microsoft tenant ID
EntityName	Possible values: Customer / Site / Department Notes: The value indicates the owning entity for the product
LinkedTenantName	Associated MS tenant name in C3 as there could be more than 1 tenant associated with C3 customer
ProductName	Name of product
OldQuantity	License count before making change (if made)
NewQuantity	current license count after making change (if made)
DateofChange	Date of update to subscription
OldStatus	previous status of subscription before making change (if made) Possible Values: Active/Suspended/Deleted/Disabled
NewStatus	current status of subscription Possible Values: Active/Suspended/Deleted/Disabled
OldPrice	price before update
NewPrice	Price after update
CreatedBy	User initiating the update
OwnerName	Name of the owner For Customer – It will be the name of the Customer For Site – It will be the name of the Site

Was this article helpful?

What's Next

Product category and Provider Category Matrix

Table of contents

URL
Request headers
Request body
Response body