Create commitments

POST

https://integrators.prod.api.tabsplatform.com/v3/commitments

Authorizationstring

API Key authentication via header

This endpoint expects an object.

contractIdstringRequired

The contract ID

commitmentslist of objectsRequired

Array of commitments to create

Usage commitments created successfully

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

400

Bad Request Error

404

Not Found Error

$	curl -X POST https://integrators.prod.api.tabsplatform.com/v3/commitments \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"contractId": "d4e5f6a7-b890-1234-cdef-56789abcdef0",
>	"commitments": [
>	{
>	"commitmentValue": 15000,
>	"commitmentUnitType": "DOLLARS",
>	"prepaidEnabled": true,
>	"billingTermIds": [
>	"b1c2d3e4-f567-890a-bcde-f1234567890a"
>	]
>	}
>	]
>	}'

1	{
2	"payload": {
3	"success": true,
4	"commitmentIds": [
5	"c3d4e5f6-a789-0123-bcde-f4567890abcd"
6	]
7	},
8	"success": true,
9	"message": "Usage commitments created successfully",
10	"error": {
11	"code": 0,
12	"message": "",
13	"details": {}
14	}
15	}