divide entitlement commit
POST https://api.suger.cloud/org/{orgId}/entitlement/{entitlementId}/divideCommit
Divide the commit equally from the given entitlement into sub entitlement terms based on the given time periods.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
entitlementId | path | string | yes | Entitlement ID |
Request Body
Required. Content-Type: application/json · Schema: DivideEntitlementCommitParams
DivideEntitlementCommitParams fields:
| Field | Type | Required | Description |
|---|---|---|---|
commitAmount | number | no | The amount of the commit to be divided. If it is less or equal to 0.0, the total commit of the entitlement will be divided into multiple sub entitlement terms with credit. |
startDates | array<string> | no | The start dates of the sub entitlement terms. The end date of the last sub entitlement term is the end date of the parent entitlement term. The first start date must be the same as the start date of the parent entitlement term. |
Responses
200 — OK
Content-Type: application/json
400 — Bad request error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.