Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Create a co-term group

Creates a new co-term group for eligible subscriptions under the same account.

post/subscriptions/coterm

Request body

accountIdstring required

The ID of the account the subscriptions belong to.

Example request

{
  "accountId": "Mn7Op8Qr9St0Uv1Wx2Yz3A",
  "coTermGroup": {
    "displayName": "Example co-term group name",
    "subscriptions": [
      "Ab1C-DeFgH-iJ2K3l4MmNo"
    ]
  }
}

Response

OK

actionstring

The action performed.

resultstring

The result of the operation.

accountIdstring

Account ID associated with the group.

Example response

{
  "action": "subscriptions.coterm.create",
  "result": "success",
  "accountId": "Mn7Op8Qr9St0Uv1Wx2Yz3A",
  "coTermGroup": {
    "coTermGroupId": "X_yZ1a2Bc3De4Fg5Hi6JkL",
    "displayName": "Example co-term group name",
    "groupingCriteria": [
      {
        "interval": [
          {
            "unit": "MONTH",
            "length": 1
          }
        ],
        "currency": [
          "USD"
        ],
        "paymentMethods": [
          {
            "type": "card",
            "ending": "*4242 (USD)"
          }
        ]
      }
    ],
    "subscriptions": [
      {
        "subscription": "Ab1C-DeFgH-iJ2K3l4MmNo",
        "status": "Co-Termed"
      }
    ]
  }
}