---
title: "Debit a Customer's Tier Membership Balances"
method: PATCH
path: "/tier/membership/{tierMembershipId}/debit"
tags: ["Tier Membership Transaction"]
deprecated: true
---

# Debit a Customer's Tier Membership Balances

`PATCH /tier/membership/{tierMembershipId}/debit`

> **Deprecated.**

This API allows a calling application to decrease the Tier Membership Balances for a customer. This  API completes a negative movement of balances only. The values passed in the balances of the request are validated to always be positive integers.

## Path parameters

- `tierMembershipId` string, required

## Headers

- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `Accept-Encoding` '' | 'gzip' | 'deflate' | 'gzip,deflate'
- `X-EES-TRANSACTION-ID` string, string
- `X-EES-RETRY` string, string

## Request body

- TierMembershipTransactionRequestEntity
  - `walletTransactionId` string — The ID of a Wallet Transaction to associate to this Tier Membership Transaction.
  - `balances` object, required
    - `points` integer — The number of Tier Membership Points to alter in the customer's Tier Membership Balance. One or many Tier Membership Balance Types can be passed together.
    - `transactions` integer — The number of Tier Membership Transactions to alter against the customer's Tier Membership Balance. One or many Tier Membership Balance Types can be passed together.
    - `spend` integer — The amount of Tier Membership Spend to alter against the customer's Tier Membership Balance. One or many tier Tier Membership Balance Types can be passed together.

## Response `201`

An object displaying the details of a Tier Membership Transaction against a customer's Tier Membership.

- object
  - `membership` TierMembershipEntity, required
    - `tierMembershipId` string, required — The unique ID for this Tier Membership. This will be a numeric string value of variable length.
    - `tierId` string, required — The ID for the Tier Membership to which the customer belongs. This will be a numeric string value of variable length.
    - `status` 'ACTIVE', required — The status of this Tier Membership.
    - `accountIds` string[], required
    - `balances` TierMembershipBalancesEntity, required
      - `transactions` integer — The value representing the Tier Membership Balance for a customer's Tier Membership relating to the number of Tier Membership Transactions completed.
      - `spend` integer — The value representing the Tier Membership Balance for a customer's Tier Membership relating to the Tier Membership Spend amount completed.
      - `points` integer — The value representing the Tier Membership Balance for a customer's Tier Membership showing the Tier Membership Points earned.
    - `expiryDate` string, required — DateTime in ATOM format.
    - `tierBalancesResetDate` string, required — DateTime in ATOM format.
    - `dateCreated` string, required — DateTime in ATOM format.
    - `lastUpdated` string, required — DateTime in ATOM format.
  - `transactions` TierMembershipTransactionEntity[], required
    - `tierMembershipTransactionId` string, required — The unique ID for this Tier Membership Transaction.
    - `tierMembershipId` string, required — The ID of the Tier Membership.
    - `transactionType` 'CREDIT' | 'DEBIT' | 'ADJUSTMENT' | 'MOVE' | 'RESET', required
    - `parentTierMembershipTransactionId` string, nullable, required — The parent Tier Membership Transaction ID.
    - `walletTransactionId` string, nullable, required — The Wallet Transaction to which this Tier Membership Transaction is linked.
    - `dateCreated` string, required — DateTime in ATOM format.
    - `lastUpdated` string, required — DateTime in ATOM format.
    - `actions` object[], required — An array that displays the actions taken within this Tier Membership Transaction. These could be actions that adjust multiple Tier Membership Balances. The `amount` key will contain a positive integer if the Tier Membership Balance increased or a negative integer if the Tier Membership Balance was decreased.
      - `balanceType` 'transactions' | 'spend' | 'points'
      - `amount` integer — The value of the action taken against the Tier Membership Balance. This can only be positive for credit or negative for debit.
      - `balanceBefore` integer — The value of the Tier Membership Balance before the transaction.
      - `balanceAfter` integer — The value of the Tier Membership Balance after the transaction. This value will be equal to: `balanceBefore + amount`.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not Found.
- `415` — Unsupported Media Type
- `429` — Too Many Requests
- `500` — Server Error

---

[API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)
