Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Update co-term group

Add or remove subscriptions from an existing co-term group.

Use the action parameter to specify "ADD" or "REMOVE".

post/subscriptions/coterm/{cotermGroupId}

Path parameters

cotermGroupIdstring required
Example:X_yZ1a2Bc3De4Fg5Hi6JkL

Unique identifier for the co-term group.

Request body

action'ADD' | 'REMOVE' required

The operation to perform on the group.

displayNamestring

Optional new name for the group.

previewboolean

If true, returns an estimate without executing changes.

prorateboolean

If true, executes changes immediately with proration.

subscriptionsstring[] required

List of Subscription IDs to add or remove.

Example request

{
  "action": "ADD",
  "displayName": "Example co-term group name",
  "preview": true,
  "prorate": true,
  "subscriptions": [
    "Fg2Hi3Jk4Lm5No6Pq7Rs8T"
  ]
}

Response

OK

actionstring

The action performed.

resultstring

The result of the operation.

Example response

{
  "action": "subscriptions.coterm.update",
  "result": "success",
  "coTermChangesResult": [
    {
      "subscription": "Fg2Hi3Jk4Lm5No6Pq7Rs8T",
      "status": "EXECUTED",
      "currentPlan": {
        "display": "Furious Falcon Analytics",
        "product": "furious-falcon-analytics",
        "billingFrequency": "1 month",
        "price": 100,
        "priceDisplay": "$100.00",
        "discountDisplay": "$0.00",
        "quantity": 1,
        "subtotal": 100,
        "subtotalDisplay": "$100.00",
        "tax": 8,
        "taxDisplay": "$8.00",
        "total": 108,
        "totalDisplay": "$108.00",
        "taxPercent": 8,
        "taxPercentDisplay": "8%",
        "periodStartDate": 1769990400000,
        "periodStartDateDisplay": "2/2/26",
        "periodStartDateDisplayISO8601": "2026-02-02",
        "periodEndDate": 1769990400000,
        "periodEndDateDisplay": "2/2/26",
        "periodEndDateDisplayISO8601": "2026-02-02",
        "prorationRemainingDays": 28,
        "prorationTotalDays": 28,
        "proratedItemCharge": 103.57,
        "proratedItemChargeDisplay": "$103.57",
        "proratedItemCredit": 100,
        "proratedItemCreditDisplay": "$100.00",
        "proratedItemSubtotal": 3.57,
        "proratedItemSubtotalDisplay": "$3.57",
        "proratedItemTax": 0.28,
        "proratedItemTaxDisplay": "$0.28",
        "proratedItemTotal": 3.85,
        "proratedItemTotalDisplay": "$3.85",
        "addons": [
          {
            "display": "Addon Name",
            "product": "addon-product-path",
            "priceDisplay": "$5.00",
            "proratedItemChargeDisplay": "$2.50"
          }
        ],
        "subscriptionSubtotal": 100,
        "subscriptionSubtotalDisplay": "$100.00",
        "subscriptionTax": 8,
        "subscriptionTaxDisplay": "$8.00",
        "subscriptionTotal": 108,
        "subscriptionTotalDisplay": "$108.00",
        "subscriptionProratedCredit": 100,
        "subscriptionProratedCreditDisplay": "$100.00",
        "subscriptionProratedCharge": 103.57,
        "subscriptionProratedChargeDisplay": "$103.57"
      },
      "proposedPlan": {
        "display": "Furious Falcon Analytics",
        "product": "furious-falcon-analytics",
        "billingFrequency": "1 month",
        "price": 100,
        "priceDisplay": "$100.00",
        "discountDisplay": "$0.00",
        "quantity": 1,
        "subtotal": 100,
        "subtotalDisplay": "$100.00",
        "tax": 8,
        "taxDisplay": "$8.00",
        "total": 108,
        "totalDisplay": "$108.00",
        "taxPercent": 8,
        "taxPercentDisplay": "8%",
        "periodStartDate": 1769990400000,
        "periodStartDateDisplay": "2/2/26",
        "periodStartDateDisplayISO8601": "2026-02-02",
        "periodEndDate": 1769990400000,
        "periodEndDateDisplay": "2/2/26",
        "periodEndDateDisplayISO8601": "2026-02-02",
        "prorationRemainingDays": 28,
        "prorationTotalDays": 28,
        "proratedItemCharge": 103.57,
        "proratedItemChargeDisplay": "$103.57",
        "proratedItemCredit": 100,
        "proratedItemCreditDisplay": "$100.00",
        "proratedItemSubtotal": 3.57,
        "proratedItemSubtotalDisplay": "$3.57",
        "proratedItemTax": 0.28,
        "proratedItemTaxDisplay": "$0.28",
        "proratedItemTotal": 3.85,
        "proratedItemTotalDisplay": "$3.85",
        "addons": [
          {
            "display": "Addon Name",
            "product": "addon-product-path",
            "priceDisplay": "$5.00",
            "proratedItemChargeDisplay": "$2.50"
          }
        ],
        "subscriptionSubtotal": 100,
        "subscriptionSubtotalDisplay": "$100.00",
        "subscriptionTax": 8,
        "subscriptionTaxDisplay": "$8.00",
        "subscriptionTotal": 108,
        "subscriptionTotalDisplay": "$108.00",
        "subscriptionProratedCredit": 100,
        "subscriptionProratedCreditDisplay": "$100.00",
        "subscriptionProratedCharge": 103.57,
        "subscriptionProratedChargeDisplay": "$103.57"
      },
      "amountDue": {
        "prorationSubtotal": 3.57,
        "prorationSubtotalDisplay": "$3.57",
        "prorationTax": 0.28,
        "prorationTaxDisplay": "$0.28",
        "totalAmountDue": 3.85,
        "totalAmountDueDisplay": "$3.85",
        "nextChargeDate": 1772496000000,
        "nextChargeDateDisplay": "3/3/26",
        "nextChargeDateDisplayISO8601": "2026-03-03",
        "nextChargeAmount": 108,
        "nextChargeAmountDisplay": "$108.00"
      },
      "discountTotals": {
        "productLevelDiscountTotalDisplay": "$0.00",
        "couponLevelDiscountTotalDisplay": "$0.00"
      }
    }
  ]
}