Get bonus plan trigger by ID
This GET operation retrieves a bonus plan trigger by ID. You pass the id in the URL as a parameter and if successful, you receive all of the information you need about the trigger ID in the JSON response.
GET /pcc/spcm/bonusPlanTrigger/<id>
HEADER INFO
authorisation: HTTP Basic Auth
tenant: <tenantName>
content-type: application/JSON
accept: application/JSON
By default, accept is XML. You must explicitly set accept in your header to application/JSON to receive a JSON response.
|
permissions: SPCM_BONUS_PLAN_CREATE_PERMISSION
JSON response
In the JSON response, you receive the trigger information.
| See the type descriptions for more details on each field. |
{
"basePlanDefinitionName":"AccumulatesOnPrecedence",
"bonusPlanDefinitionName":"absoluteExpiry1",
"validityPeriod":"2228days",
"unitAmountPercentage":20,
"renewal":true
}
Bonus plan trigger type descriptions
| Field | Type | Description | Mandatory | ||
|---|---|---|---|---|---|
|
String (max length 255) |
Name of purchased Plan Definition. |
Yes |
||
|
string (max length 255) |
Name of bonus Plan Definition. |
|
||
|
string (max length 255) |
Overrides the validity period in the Plan Definition. |
|
||
|
long |
Overrides the unit amount in the Plan Definition. Mutually exclusive with |
|
||
|
integer |
Percentage unit amount (the calculation using the original unit amount of the base plan. Mutually exclusive with "unitAmount"). |
|
||
renewal |
boolean |
Indicates if the bonus plan should be added on base plan renewal.
|
|