Skip to main content

Fields

accountNumber : String

The account number associated with this reward.

claimedAt : DateTime

The datetime at which the reward was initially claimed.

id : Int

The unique id of the reward.

The offer claimed as part of this reward.

offerName : String

The display name of the offer.

Deprecation
The 'offerName' field is deprecated.

Please use 'offer.name' instead

- Marked as deprecated on 2023-12-21.
- Scheduled for removal on or after 2024-02-10.
offerSlug : String

The human-readable identifier for the offer.

Deprecation
The 'offerSlug' field is deprecated.

Please use 'offer.slug' instead

- Marked as deprecated on 2023-12-21.
- Scheduled for removal on or after 2024-02-10.
partnerName : String

The name of the reward partner.

Deprecation
The 'partnerName' field is deprecated.

Please use 'offer.partner_name' instead

- Marked as deprecated on 2023-12-21.
- Scheduled for removal on or after 2024-02-10.
priceTag : String

The price tag for the offer.

Deprecation
The 'priceTag' field is deprecated.

Please use 'offer.price_tag' instead

- Marked as deprecated on 2023-12-21.
- Scheduled for removal on or after 2024-02-10.

The current status of the reward.

usageInstructions : String

The instructions for how to use the reward.

Deprecation
The 'usageInstructions' field is deprecated.

Please use 'offer.usage_instructions' instead

- Marked as deprecated on 2023-12-21.
- Scheduled for removal on or after 2024-02-10.
vouchers : [VoucherType]

The voucher associated with this reward.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-CA4C25FB", "claimedAt": "1970-09-09T11:28:23.236454+00:00", "id": 51876967, "offer": OctoplusOfferType, "status": "PENDING", "vouchers": OctoplusVoucherType }