Delete commitment schedule

DELETE

https://integrators.prod.api.tabsplatform.com/v3/contracts/:id/commitments/:commitmentId/schedules/:scheduleId

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

commitmentIdstringRequired

Commitment Id

scheduleIdstringRequired

Schedule Id (must be the last non-deleted schedule)

Request

This endpoint expects an object.

cascadeBillingTermsbooleanRequired

Required. Container and overage BTs are always torn down on schedule deletion regardless of this flag. When true, base BT endDates are also re-synced (shortened) so they no longer extend through the deleted schedule’s date range. When false, base BTs are left untouched and the caller owns realignment.

Response

Schedule deleted

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

$	curl -X DELETE https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/schedules/scheduleId \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"cascadeBillingTerms": true
>	}'

1	{
2	"payload": {
3	"success": true
4	},
5	"success": true,
6	"message": "string",
7	"error": {
8	"code": 1.1,
9	"message": "string",
10	"details": {}
11	}
12	}