- 16 Jul 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get active customers
- Updated on 16 Jul 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get a list of active customers onboarded on the platform along with others attribute like associated plan, payment method and other details available for download as CSV via UI
URL
GET https://contoso-prod-api.azurewebsites.net/api/activecustomers/details/
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": "dff42334-0ed8-4698-b570-ff3b8572b5b2",
"ErrorMessage": null,
"ErrorDetail": null,
"Data": [
{
"Name": "Contoso",
"CustomerID": "1BFDA99D-1234-4E61-A230-9EAF5BD38BCB",
"TenantId": "cf3334f1-81b5-67895-ace9-d9af12345e92",
"TenantName": "Contoso",
"DomainName": "contoso.onmicrosoft.com",
"Tags": null,
"CurrencyCode": "USD",
"SignupDate": "2022-12-22T23:31:49.49",
"OnboardStatus": "Onboarded",
"ResellerC3Id": null,
"PaymentMethod": "Manual",
"PlanName": "Azure Discount 00.0%,Corporate Legacy - NCE & Legacy Licensing - Discount 00.0%",
"AutoPay": "No",
"DeletedOn": null,
"BillingReferenceId": ""
},
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:
|