Get Product History

Prev Next

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": "d4454846-d8c3-466d-817a-42f6d9398deb",
    "ErrorMessage": null,
    "ErrorDetail": null,
    "Data": [
        {
            "CustomerID": "BFB67FA2-FA0A-4451-B3E5-2A905276DDFD",
            "CustomerName": "Contoso",
            "TenantID": "07c0adc5-48b1-4b92-9da4-0a603317de5d",
            "SubscriptionID": "e0929157-458c-426e-9e4c-60148da29b37",
            "EntityName": "Customer",
            "LinkedTenantName": "Contoso",
            "ProductName": "Microsoft 365 E1",
            "OldQuantity": 1,
            "NewQuantity": 6,
            "DateofChange": "2024-10-16T11:40:15.353",
            "OldStatus": "Active",
            "NewStatus": "Active",
            "OldPrice": 40.0000,
            "NewPrice": 40.0000,
            "CreatedBy": "user@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

SubscriptionID
Subscription identifier

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