Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Contract

End-date Contract Account billing entities

Apply the specified end-date to billing entities associated with Accounts the Contract has been added to, and apply the end-date to the Contract itself.

NOTES:

  • If you want to apply the end-date to the Contract itself - the Contract id you use as the required PATH PARAMETER - you must also specify CONTRACT as a billingEntities option in the request body schema.
  • Only the Contract whose id you specify for the PATH PARAMETER will be end-dated. If there are other Contracts associated with the Account, these will not be end-dated.
  • When you successfully end-date billing entities, the version number of each entity is incremented.
put/organizations/{orgId}/contracts/{id}/enddatebillingentities

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

idstring required

Unique identifier (UUID) of the Contract - the specified billing entities associated with the Account the Contract has been added to will be end-dated.

Request body

endDatestring date-time required

The end date and time applied to the specified billing entities (in ISO 8601 format).

applyToChildrenboolean

A Boolean TRUE/FALSE flag. For Parent Accounts, set to TRUE if you want the specified end-date to be applied to any billing entities associated with Child Accounts. (Optional)

billingEntitiesBillingEntity[] required

Defines which billing entities associated with the Account will have the specified end-date applied. For example, if you want the specified end-date to be applied to all Prepayments/Commitments created for the Account use "PREPAYMENT".

Response

Return the status and details of the updated active billing entities

statusMessagestring

A message indicating the status of the operation.