Change event type for selected billing terms and POBs in a group

patch

https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/billing-term-groups/{groupId}/event-type

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Contract Id

groupId

string

required

Billing Term Group Id

Body Params

billingTermIds

array of strings

required

Defaults to []

IDs of the billing terms (within the group) whose event type should be set to toEventTypeId. Pick exactly the rows to change — in a many-to-many group the others are left untouched. May be empty when only performance obligations are being changed.

billingTermIds*

performanceObligationIds

array of strings

required

Defaults to []

IDs of the performance obligations (within the group) whose event type should be set to toEventTypeId. May be empty when only billing terms are being changed.

performanceObligationIds*

toEventTypeId

uuid

required

The event type to assign to the selected billing terms and performance obligations. Must belong to the merchant.

Responses

400

Invalid request, or a provided BT/POB does not belong to the group

404

Contract, billing term group, or target event type not found

409

Change would break the event-type invariant for the group

500

Internal Server Error

200Event type changed for the selected billing terms and performance obligations within the group; any rows not listed in the request are left untouched. The change is applied atomically and is only accepted if the group's event types stay in sync afterward.