Stubs Reward Summaries

V3 V4

The Stubs Reward Summaries endpoints provide read-only access to reward summaries.


Endpoints

Verb Endpoint Description
GET v4/amc-accounts/{accountId}/loyalty/reward-summary Returns the reward summary for the given accountId.
GET v4/loyalty-cards/{loyaltyCardNumber}/reward-summaries Returns the reward summary for the given loyalty card number.

AmcAccount


AmcAccount Properties

Name Description
pendingPoints Points earned during purchase but not vested until midnight following the show time
concessionUpgrades Number of concession upgrades
currentActiveYearVisits
freeConcessionUpgrades Dollar amount of concession upgrades missed out on during Insider account's lifetime
freeOnlineFeesWaived Dollar amount of online fee waivers missed out on during Insider account's lifetime
freeSpend Count of loyalty points missed out on during Insider account's lifetime
giveawaySavings Dollar amount of random giveaway rewards earned during account's lifetime
lifetimeRewardsEarned Dollar amount of rewards earned during account's lifetime
onlineFeesWaived Dollar amount of online fees waived for account
pointBalance
pointsToNextReward
rewardsBalance Dollar amount of rewards available to the account
savingToDate Dollar amount of total savings for the account's lifetime
spendToNextReward Dollar amount needed to spend until the next reward is credited to the account
sweepstakes Count of entries into monthly sweepstakes for the current month
totalSpent Dollar amount spent leading up to the next reward credit
currentActiveYearVisits Number of visits the account has made for the year
visitsToNextGoal Number of visits needed to reach next goal
_embedded.Expirations A list of Expirations Representations returned.
_embedded.BirthdayOffers A list of BirthdayOffers Representations returned.
_embedded.BonusBucks A list of BonusBucks Representations returned.


AmcAccount Links

Relation Description Methods Templated
self The current rewards for the given accountId or card number GET No

Expirations


Expirations Properties

Name Description
amount Dollar amount of expiring reward
daysToExpire Number of days until reward expires
expirationDate Date of reward expiration
comment Description of birthday reward

BirthdayOffers


BirthdayOffers Properties

Name Description
amount Amount of birthday reward
expirationDate Date of reward expiration
comment Description of birthday reward

BonusBucks


BonusBucks Properties

Name Description
amount Amount of bonus bucks
daysToExpire Number of days until reward expires
expirationDate Date of reward expiration
comment Description of bonus bucks reward


Examples

Returns the reward summary for the given accountId.
GET  v4/amc-accounts/123456/loyalty/reward-summary

Response

{
  "pendingPoints": 0,
  "concessionUpgrades": 0,
  "lifetimeRewardsEarned": 0,
  "onlineFeesWaived": 0,
  "pointBalance": 0,
  "pointsToNextReward": 0,
  "rewardsBalance": 0,
  "savingToDate": 0,
  "spendToNextReward": 92,
  "totalSpent": 8,
  "currentActiveYearVisits": 12,
  "visitsToNextGoal": 3,
  "expirations": [
    {
      "amount": 20,
      "daysToExpire": 318,
      "expirationDate": "2017-05-11",
      "comment": "Reward Achieved"
    }
  ],
  "birthdayOffers": [
    {
      "amount": 1,
      "expirationDate": "2016-07-16",
      "comment": "Premiere Birthday Offer- Large Drink"
    },
    {
      "amount": 1,
      "expirationDate": "2016-07-16",
      "comment": "Premiere Birthday Offer- Large Popcorn"
    }
  ],
  "bonusBucks": [
    {
      "amount": 5,
      "expirationDate": "2016-07-16",
      "daysToExpire": 14,
      "comment": "Summer Membership Drive"
    }
  ],
  "_links": {
    "self": {
      "href": "http://test.amcstubs.com:4000/v3/amc-accounts/123456/loyalty/reward-summary",
      "templated": false
    }
  }
}
Returns the reward summary for the given loyalty card number.
GET  v4/loyalty-cards/1102059900263000/reward-summaries

Response

{
  "pendingPoints": 0,
  "concessionUpgrades": 0,
  "lifetimeRewardsEarned": 0,
  "onlineFeesWaived": 0,
  "pointBalance": 0,
  "pointsToNextReward": 0,
  "rewardsBalance": 0,
  "savingToDate": 0,
  "spendToNextReward": 92,
  "totalSpent": 8,
  "currentActiveYearVisits": 12,
  "visitsToNextGoal": 3,
  "expirations": [
    {
      "amount": 20,
      "daysToExpire": 318,
      "expirationDate": "2017-05-11",
      "comment": "Reward Achieved"
    }
  ],
  "birthdayOffers": [
    {
      "amount": 1,
      "expirationDate": "2016-07-16",
      "comment": "Premiere Birthday Offer- Large Drink"
    },
    {
      "amount": 1,
      "expirationDate": "2016-07-16",
      "comment": "Premiere Birthday Offer- Large Popcorn"
    }
  ],
  "bonusBucks": [
    {
      "amount": 5,
      "expirationDate": "2016-07-16",
      "daysToExpire": 14,
      "comment": "Summer Membership Drive"
    }
  ],
  "_links": {
    "self": {
      "href": "http://test.amcstubs.com:4000/v3/amc-accounts/123456/loyalty/reward-summary",
      "templated": false
    }
  }
}