v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

Execute co-term group changes

Finalizes the co-term group and applies billing changes.

This operation generates an Order ID and returns the new aligned billing period dates for the group.

post/subscriptions/coterm/{cotermGroupId}/execute

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.

orderstring

The ID of the order generated by this execution.

proratedboolean

Indicates if proration was applied.

timezonestring

Timezone used for the period calculations.

periodStartDateinteger

Timestamp of the new aligned period start.

periodStartDateDisplaystring

Human-readable display of the period start date.

periodStartDateDisplayISO8601string

ISO8601 formatted string of the period start date.

periodEndDateinteger

Timestamp of the new aligned period end.

periodEndDateDisplaystring

Human-readable display of the period end date.

periodEndDateDisplayISO8601string

ISO8601 formatted string of the period end date.

subscriptionsstring[]

List of Subscription IDs successfully executed.

Example response

{
  "action": "subscriptions.coterm.execute",
  "result": "success",
  "coTermGroupId": "X_yZ1a2Bc3De4Fg5Hi6JkL",
  "order": "JQVCfHTZTSSyyV4c2D20Iw",
  "prorated": true,
  "timezone": "UTC",
  "periodStartDate": 1770076800000,
  "periodStartDateDisplay": "2/3/26",
  "periodStartDateDisplayISO8601": "2026-02-03",
  "periodEndDate": 1772409600000,
  "periodEndDateDisplay": "3/2/26",
  "periodEndDateDisplayISO8601": "2026-03-02",
  "subscriptions": [
    "Ab1C-DeFgH-iJ2K3l4MmNo"
  ]
}