Home
API reference
Platform API reference
Platform API
Transaction Usage
Get product classifications

Get product classifications

get/v1/organizations/{organizationId}/product-classifications
Page View

Transaction usage endpoints allow you to review and export transaction usage data for your current Redox contract. This allows you to easily monitor your usage and limits as you go.

You can get details for all the Redox product(s) in your contract, retrieve metrics by product type, and export metrics.

Get product classifications

Retrieve a list of Redox product(s) your organization has purchased (whether currently, previously, or for future use) and review contract details. You can modify the query to include only active (i.e., current) products and/or exclude duplicate listings for a Redox product. 

The response contains transaction limit details and contract dates for all relevant Redox product(s).

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/product-classifications' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • organizationId
    required, string

    Identifies the Redox organization that you're operating in.

Query Parameters

  • includeInactive
    boolean

    Indicates whether inactive (i.e., either future or historical) Redox product(s) should be included in the response.

  • includeDuplicates
    boolean

    Indicates whether potentially duplicate Redox product(s) should be included in the response. The possibility of duplicates will likely be rare for active products; however, it may be possible for inactive product(s).

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "activeProductClassifications": [
7
      {
8
        "id": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
9
        "name": "cm_access_ceq",
10
        "label": "Access CEQ",
11
        "limit": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
12
        "consumptionPeriod": "Month",
13
        "startDate": "2023-01-01",
14
        "endDate": "2023-12-31",
15
        "status": "Active"
16
      }
17
    ],
18
    "inactiveProductClassifications": [
19
      {
20
        "id": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
21
        "name": "cm_access_ceq",
22
        "label": "Access CEQ",
23
        "limit": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
24
        "consumptionPeriod": "Month",
25
        "startDate": "2023-01-01",
26
        "endDate": "2023-12-31",
27
        "status": "Active"
28
      }
29
    ]
30
  }
31
}

    Contains the payload and metadata returned for Get product classifications.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • activeProductClassifications
      Array of object

      Contains the currently active Redox product classifications for an organization.

      • id
        string

        Displays the UUID of the Redox product being used by a given organization.

      • name
        string

        Displays the CRM internal name for the Redox product.

      • label
        string

        Displays the human-readable name for the Redox product.

      • limit
        number

        Defines the number of transactions purchased for the Redox product within the selected limit type.

      • consumptionPeriod
        string

        Defines the time window for the transaction limit. Month and Annual mean that transaction usage limit resets each calendar month or year respectively. Contract Term means that the transaction usage doesn't reset; instead, the limit lasts for the duration of the contract.

        Possible Values: Annual, Contract Term, Month
      • startDate
        string

        Contains the date-time in ISO 8601 format to define the start of the Redox product contract.

      • endDate
        string

        Contains the date-time in ISO 8601 format to define the end of the Redox product contract.

      • status
        string

        Indicates the CRM status of the Redox product contract, whether active, future, or expired.

        Possible Values: Active, Future, Expired
    • inactiveProductClassifications
      Array of object

      Contains the expired or future product classifications for an organization.

      • id
        string

        Displays the UUID of the Redox product being used by a given organization.

      • name
        string

        Displays the CRM internal name for the Redox product.

      • label
        string

        Displays the human-readable name for the Redox product.

      • limit
        number

        Defines the number of transactions purchased for the Redox product within the selected limit type.

      • consumptionPeriod
        string

        Defines the time window for the transaction limit. Month and Annual mean that transaction usage limit resets each calendar month or year respectively. Contract Term means that the transaction usage doesn't reset; instead, the limit lasts for the duration of the contract.

        Possible Values: Annual, Contract Term, Month
      • startDate
        string

        Contains the date-time in ISO 8601 format to define the start of the Redox product contract.

      • endDate
        string

        Contains the date-time in ISO 8601 format to define the end of the Redox product contract.

      • status
        string

        Indicates the CRM status of the Redox product contract, whether active, future, or expired.

        Possible Values: Active, Future, Expired