Member Benefits
Retrieve a list of benefits for a member, while asynchronously requesting data from the Member Benefits API.
| Parameter | Type | Description | Required or Optional |
|---|---|---|---|
devMode | Boolean | Indicates whether the request is run in developer mode (true) or not (false). | Optional |
memberId | String | Identifier of the member whose benefits are being retrieved. | Required |
version | String | Version of the API. The request body is available in version 55.0 and later. | Optional |
A BenefitModel instance of type:
| Parameter | Type | Description |
|---|---|---|
benefitId | String | The ID of the benefit available for the member. |
benefitName | String | The name of the benefit available for the member. |
benefitTypeId | String | The ID of the associated benefit type record. |
benefitTypeName | String | The name of the associated benefit type. |
createdRecordId | String | The ID of the record created during benefit assignment. |
createdRecordName | String | The display name of the record created during benefit assignment. |
description | String | The description of the benefit available to a loyalty program member. |
endDate | String | The date the benefit expires. |
isActive | Boolean | Indicates whether the benefit is active (true) or not (false). |
memberBenefitStatus | String | The status of the benefit available for the member. |
startDate | String | The date from when the benefit applies to a member. |