Customers detailed subscriptions

GET /v2/subscription-detailed/customers

Retrieves detailed subscription information for customers, including subscription metadata, item-level pricing, consumption details, and duration. Supports pagination and metadata for total records and page settings.

Query Parameters

• sort - Sort order for the results
• page - Page number for pagination
• perPage - Parameter for perPage
• ~filter[startDate] - Parameter for ~filter[startDate]
• ~search - Parameter for ~search
• ~filter[_id] - Parameter for ~filter[_id]
• ~filter[endDate] - Parameter for ~filter[endDate]
• ~filter[price] - Parameter for ~filter[price]
• ~filter[subscriptionCreatorFullName] - Parameter for ~filter[subscriptionCreatorFullName]

Request Example

GET /v2/subscription-detailed/customers?sort=-created&page=0&perPage=25

Headers

• Accept - Expected response format (Example: application/json)
• \~Accept - Custom header for ~Accept (Example: text/csv)

Response Example

{
  "data": [
    {
      "_id": "subscription-item-id-1",
      "subscriptionId": "subscription-id-1",
      "subscriptionName": "Example Backup Service",
      "subscriptionCustomerId": "customer-id-1",
      "subscriptionCustomerName": "Example Company",
      "subscriptionLengthMonth": 36,
      "subscriptionBillingCycleMonth": 12,
      "subscriptionCreatorFullName": "Example User",
      "subscriptionStatus": "active",
      "tenant": "tenant-id-1",
      "itemId": "item-id-1",
      "itemName": "Backup Unlimited",
      "itemSku": "SKU-1000",
      "itemDescription": "Comprehensive cloud backup and restore service.",
      "itemUnitCost": 55,
      "itemUnitPrice": 55,
      "itemMonthlyPrice": 27500,
      "itemBillingPrice": 330000,
      "itemAgreementPrice": 990000,
      "itemAmount": 1000,
      "itemPrepaidAmount": 1000,
      "itemConsumptionProperty": "licensed_users",
      "itemConsumptionMetadata": "backup",
      "itemDistributorSubscriptionLengthMonth": 1,
      "itemDistributorBillingCycleMonth": 12,
      "startDate": "2025-06-27T11:16:40.729Z",
      "endDate": "2028-06-27T11:16:40.729Z",
      "created": "2025-06-27T11:16:40.740Z",
      "updated": "2025-10-02T19:01:31.083Z"
    },
    {
      "_id": "subscription-item-id-2",
      "subscriptionId": "subscription-id-2",
      "subscriptionName": "Example Backup Service",
      "subscriptionCustomerId": "customer-id-1",
      "subscriptionCustomerName": "Example Company",
      "subscriptionLengthMonth": 12,
      "subscriptionBillingCycleMonth": 12,
      "subscriptionCreatorFullName": "Example User",
      "subscriptionStatus": "active",
      "tenant": "tenant-id-1",
      "itemId": "item-id-2",
      "itemName": "Backup 80GB",
      "itemSku": "SKU-1001",
      "itemDescription": "Backup plan with 80GB per user.",
      "itemUnitCost": 42,
      "itemUnitPrice": 42,
      "itemMonthlyPrice": 134.4,
      "itemBillingPrice": 1612.8,
      "itemAgreementPrice": 1612.8,
      "itemAmount": 4,
      "itemPrepaidAmount": 4,
      "itemConsumptionProperty": "protected_users",
      "itemConsumptionMetadata": "backup",
      "itemDistributorSubscriptionLengthMonth": 1,
      "itemDistributorBillingCycleMonth": 12,
      "startDate": "2025-06-20T09:04:11.678Z",
      "endDate": "2026-06-20T09:04:11.678Z",
      "created": "2025-06-20T09:04:11.720Z",
      "updated": "2025-10-02T19:01:31.026Z"
    }
  ],
  "metadata": {
    "total": 3,
    "page": 0,
    "perPage": 25,
    "maxPageSize": 1000
  }
}