Member Benefits

Retrieve a list of benefits for a member, while asynchronously requesting data from the Member Benefits API.

ParameterTypeDescriptionRequired or Optional
devModeBooleanIndicates whether the request is run in developer mode (true) or not (false).Optional
memberIdStringIdentifier of the member whose benefits are being retrieved.Required
versionStringVersion of the API. The request body is available in version 55.0 and later.Optional

A BenefitModel instance of type:

ParameterTypeDescription
benefitIdStringThe ID of the benefit available for the member.
benefitNameStringThe name of the benefit available for the member.
benefitTypeIdStringThe ID of the associated benefit type record.
benefitTypeNameStringThe name of the associated benefit type.
createdRecordIdStringThe ID of the record created during benefit assignment.
createdRecordNameStringThe display name of the record created during benefit assignment.
descriptionStringThe description of the benefit available to a loyalty program member.
endDateStringThe date the benefit expires.
isActiveBooleanIndicates whether the benefit is active (true) or not (false).
memberBenefitStatusStringThe status of the benefit available for the member.
startDateStringThe date from when the benefit applies to a member.