add entitlement credit
POST https://api.suger.cloud/org/{orgId}/entitlement/{entitlementId}/addCredit
Add the credit amount to the given Entitlement. The credit amount is accumulated & saved in the current Entitlement Term of the given Entitlement.
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: AddEntitlementCreditParams
AddEntitlementCreditParams fields:
| Field | Type | Required | Description |
|---|---|---|---|
creditAmountIncrement | number | yes | The amount to be added to the credit amount. |
entitlementID | string | yes | |
entitlementTermID | string | no | This is optional. If it is empty, the credit will be added to the default entitlement term of the entitlement. |
organizationID | string | yes |
Responses
200 — OK
Content-Type: application/json · Schema: AddEntitlementCreditResponse
AddEntitlementCreditResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
creditAmountIncrement | number | no | The amount to be added to the credit amount. |
entitlementID | string | no | |
entitlementTermID | string | no | |
newCreditAmount | number | no | The new credit amount after the increment. |
organizationID | string | no |
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.