Contracts

Append commitment step

View as Markdown

Authentication

Authorizationstring
API Key authentication via header

Path parameters

idstringRequired
Contract Id
commitmentIdstringRequired
Commitment Id

Request

This endpoint expects an object.
scheduleIdstringRequired
Schedule on the parent commitment that the new step is being appended to
commitmentValuedoubleRequired
Commitment amount value for the new step
commitmentUnitTypeenumRequired
Unit type for the commitment value
pricePriorityenumRequired
Price priority for the step
prepaidEnabledbooleanRequired
Whether prepaid is enabled for the new step
billingTermIdslist of stringsRequired
Base usage billing term IDs to link to the new step
prepaidValuedoubleOptional

Prepaid amount for the new step (when prepaid is enabled)

overageBillingTermslist of objectsOptional

Per-base-BT overage config; omit if the new step has no overage

containerConfigobjectOptional

Optional naming + ERP item ID overrides for prepaid and true-up container BTs

Response

Step appended
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error