v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

Retrieve a co-term group

Retrieves details for a specific co-term group using its ID.

get/subscriptions/coterm/{cotermGroupId}

Path parameters

cotermGroupIdstring required

Example:X_yZ1a2Bc3De4Fg5Hi6JkL

Unique identifier for the co-term group.

Response

actionstring

The action performed.

resultstring

The result of the operation.

coTermGroupIdstring

Unique identifier for the co-term group.

displayNamestring

Display name of the group.

accountstring

Account ID associated with the group.

initialOrderstring

The ID of the order that initiated the group.

nextPeriodDateinteger

Timestamp of the next billing period start.

nextPeriodDateDisplaystring

Human-readable display of the next billing date.

nextPeriodDateDisplayISO8601string

ISO8601 formatted string of the next billing date.

Example response

{
  "action": "subscriptions.coterm.get",
  "result": "success",
  "coTermGroupId": "X_yZ1a2Bc3De4Fg5Hi6JkL",
  "displayName": "Example co-term group name",
  "account": "Mn7Op8Qr9St0Uv1Wx2Yz3A",
  "initialOrder": "JQVCfHTZTSSyyV4c2D20Iw",
  "nextPeriodDate": 1772496000000,
  "nextPeriodDateDisplay": "3/3/26",
  "nextPeriodDateDisplayISO8601": "2026-03-03",
  "groupingCriteria": {
    "interval": [
      {
        "unit": "MONTH",
        "length": 1
      }
    ],
    "currency": [
      "USD"
    ],
    "paymentMethods": [
      {
        "type": "card",
        "ending": "*4242 (USD)"
      }
    ]
  },
  "subscriptions": [
    {
      "subscription": "Qr5St6Uv7Wx8Yz9A0Bc1De",
      "baseSubscriptionProduct": "furious-falcon-pro",
      "baseSubscriptionProductDisplay": "Furious Falcon Pro",
      "periodStartDate": 1770076800000,
      "periodStartDateDisplay": "2/3/26",
      "periodStartDateDisplayISO8601": "2026-02-03",
      "nextPeriodDate": 1772496000000,
      "nextPeriodDateDisplay": "3/3/26",
      "nextPeriodDateDisplayISO8601": "2026-03-03",
      "coTermStatus": "Executed",
      "renewalAmount": "$100.00"
    }
  ]
}