Customer Subscriptions API

This API is currently an experimental feature.
Changes may occur.

The Customer Subscriptions API allows you to retrieve a list of end customers and the subscriptions purchased by this specific customer.

The endpoint for this is: /api/v1/customer-subscriptions

JSON schema

JSON

[
  {
    "customerId":  "......",
    "customerName":  "......",
    "customerStatus":  "......",
    "customerCountry":  "......",
    "customerErpOrganizationId":  "......",
    "customerCustomProperties": [
      {
        "key":  "......",
        "value":  "......"
      }
    ],
    "subscriptions": [
      {
        "priceConfiguration": {
          "customerUnitPrice": ......,
          "customerTotalPrice": ......,
          "currencyCode":  "......",
          "billingFrequency":  "......",
          "partnerTotalPrice": ......,
          "partnerUnitPrice": ......
        },
        "subscriptionCustomProperties": [
          {
            "key":  "......",
            "value":  "......"
          }
        ],
        "isTrial": ......,
        "vendorId":  "......",
        "vendorName":  "......",
        "vendorSubscriptionId":  "......",
        "components": [],
        "autoRenewalDetails": {
          "autoRenewOn":  "......",
          "autoRenewEnabled": ......,
          "scheduleOnRenewFrom":  "......",
          "scheduleOnRenewTill":  "......",
          "scheduleOnRenewEnabled": ......
        },
        "subscriptionId":  "......",
        "offerId":  "......",
        "azureTenantId":  "......",
        "subscriptionName":  "......",
        "domain":  "......",
        "quantity": ......,
        "startDate":  "......",
        "endDate":  "......",
        "subscriptionState":  "......"
      }
    ]
  }
]

Customer Subscriptions

Field	Data type	Description
customerId	string (UUID)	The identifier of the customer account/organization
customerName	string	The company name of the customer
customerStatus	string	State of the customer. Possible values are: New, Active, Suspended, Rejected, Removed
customerCountry	string	Country of the customer, e.g.: Netherlands
customerErpOrganizationId	string	The ERP ID of the customer as set in the Cloud Platform
customerCustomProperties	array(CustomProperty)	An array of custom properties as defined in under "Custom fields" in the Cloud Platform Only fields which have a value will be available
subscriptions	array(Subscription)	An array of subscriptions this customer has

CustomProperty

Field	Data type	Description
key	string	The key of the custom property as defined under "Custom fields" in the Cloud Platform
value	string	Value assigned to the customer/subscription for this custom field

Subscription

Field	Data type	Description
priceConfiguration	PriceConfiguration	Detailed pricing information for this subscription
subscriptionCustomProperties	array(CustomProperty)	An array of custom properties as defined in under "Custom fields" in the Cloud Platform Only fields which have a value will be available
isTrial	boolean	If the subscription is based on a trail offer
vendorId	string (UUID)	The unique identifier of the vendor
vendorName	string	The name of the vendor
vendorSubscriptionId	string	The unique identifier the vendor has assigned to this subscription
components	array(Component)	Subscription configuration details. Different per vendor, offer and subscription
autoRenewalDetails	AutorenewalDetails	Detailed information about auto-renewal configuration
subscriptionId	string (UUID)	The unique identifier of this subscription
offerId	string (UUID)	The unique identifier of the offer this subscription is purchased for
azureTenantId	string (UUID)	The unique identifier of the Azure Tenant (only if applicable)
subscriptionName	string	Name of the subscription
domain	string	Azure domain if applicable, otherwise a unique identifier (UUID)
quantity	number	Amount of licenses/services purchased
startDate	string	Initial start date of the subscription
endDate	string	End data of the subscription (or auto-renewal date when auto-renewal is enabled)
subscriptionState	string	State of the subscription: Possible values are: Suspended, Active, Deleted, NotProvisioned

Component

Field	Data type	Description
key	string	The unique configuration identifier
value	any (string, multi-dimensional object, etc)	Value for the configuration component. Can be any data type

PriceConfiguration

Field	Data type	Description
customerUnitPrice	number	Customer purchase price of an individual license or service
customerTotalPrice	number	Customer total price of the licenses or services purchased
currencyCode	string	Short-code for the currency, e.g.: EUR
billingFrequency	string	Billing frequency. Possible values are: One Time, Monthly, Quarterly, Yearly, Custom, None
partnerTotalPrice	number	Partner purchase price of an individual license or service
partnerUnitPrice	number	Partner total price of the licenses or services purchased

AutorenewalDetails

Field	Data type	Description
autoRenewOn	string	ISO-8601 date-time when the subscription will automatically be renewed (only if applicable)
autoRenewEnabled	boolean	If auto-renewal is enabled: true/false
scheduleOnRenewFrom	string
scheduleOnRenewTill	string
scheduleOnRenewEnabled	boolean