Get active customers Details

Prev Next

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": "7e5e5d40-21a2-4daa-a68e-c745b4cd7c74",
    "ErrorMessage": null,
    "ErrorDetail": null,
    "Data": [
        
       {
            "Name": "1 Azure Awesome Computers",
            "CustomerID": "78CC4BB7-2A0D-49A0-9DD9-4199CE02C27A",
            "TenantId": "204ac14e-0428-47dc-ade0-eeb1af753ddc",
            "TenantName": "1 Azure Awesome Computers",
            "DomainName": "test9002.onmicrosoft.com",
            "Tags": "[{\"TagKey\":\"Test\",\"TagValue\":\"sample\"}]",
            "CurrencyCode": "USD",
            "SignupDate": "2022-12-08T09:01:54.38",
            "OnboardStatus": "Onboarded",
            "ResellerC3Id": null,
            "PaymentMethod": "Manual",
            "PlanName": "CT - CSP All Products,--bundle_quantity_17072024",
            "AutoPay": "Yes",
            "DeletedOn": null,
            "BillingReferenceId": null,
            "MarketCode": "US"
        },

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

Name

name of the customer

CustomerID

Unique identifier for the customer in C3

TenantId

MS tenant id

TenantName

Tenant Name in Microsoft Partner Center

DomainName

Domain name of MS tenant

Tags

Tags configured for a customer in C3

CurrencyCode

Currency associated with customer

SignupDate

Date of customer onboarding to C3.

OnboardStatus

Status of customer in C3 (Onboarded/Deleted)

ResellerC3ID

Unique identifier for the Reseller in C3, this value will show up for customer’s onboarded under Reseller

PaymentMethod

Manual/Credit Card/ACH

PlanName

Name of plan(s) assigned to customer

AutoPay

Yes/No

DeletedOn

Date of soft deletion of customer (if deleted in C3)

BillingReferenceId

Custom value set by the Partner on the customer via Customer Configuration

MarketCode
Market for the Customer