> ## Documentation Index
> Fetch the complete documentation index at: https://help-loyalife.xoxoday.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Expiry Schedule

> Retrieve the periodic points expiry schedule for a member.

Returns the points expiry schedule for a member broken down by period (e.g. quarterly), showing how many points will expire at each upcoming date. Use this to surface expiry warnings in your loyalty portal — "X points expire on Dec 31" — which is one of the most effective nudges for driving redemption activity. The `Year` parameter lets you fetch future schedules for proactive campaign planning.

## Responses

<AccordionGroup>
  <Accordion title="200 — Success">
    | Path                                                       | Type    | Description                                                           |
    | ---------------------------------------------------------- | ------- | --------------------------------------------------------------------- |
    | `results.IsSucessful`                                      | boolean | `true`                                                                |
    | `results.ErrorCode`                                        | string  | `000`                                                                 |
    | `results.ReturnObject.Period`                              | string  | Expiry period type (e.g. `Quarterly`)                                 |
    | `results.ReturnObject.ExpiryPeriod[].ScheduleDate`         | string  | Date when this batch of points expires                                |
    | `results.ReturnObject.ExpiryPeriod[].AccrualPoints`        | integer | Points accrued in this period                                         |
    | `results.ReturnObject.ExpiryPeriod[].RedeemPoints`         | integer | Points redeemed in this period                                        |
    | `results.ReturnObject.ExpiryPeriod[].BlockedPoints`        | integer | Points currently on hold/blocked                                      |
    | `results.ReturnObject.ExpiryPeriod[].TotalExpiredPoints`   | integer | Points that have already expired in this period                       |
    | `results.ReturnObject.ExpiryPeriod[].TotalAvailablePoints` | integer | Points still available (accrual minus redeemed, blocked, and expired) |
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml POST /lbms-ingress/transaction-lm/API/Transaction/GetExpirySchedule
openapi: 3.1.0
info:
  title: Loyalife LBMS API
  description: >-
    REST API for Loyalife's Loyalty Management System. Covers member management,
    OTP authentication, loyalty transactions, and points redemption.
  version: 1.0.0
  contact:
    name: Xoxoday Support
    email: support@xoxoday.com
servers:
  - url: https://loyalife-api.xoxoday.in
    description: Production
security:
  - bearerAuth: []
paths:
  /lbms-ingress/transaction-lm/API/Transaction/GetExpirySchedule:
    post:
      tags:
        - Transactions
      summary: Get Expiry Schedule
      description: Retrieve the periodic points expiry schedule for a member.
      operationId: getExpirySchedule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - RelationReference
                - RelationType
                - ProgramId
                - TransactionCurrency
                - Year
              properties:
                RelationReference:
                  type: string
                  example: jane.doe@example.com
                RelationType:
                  type: integer
                  example: 4
                ProgramId:
                  type: integer
                  example: 19
                TransactionCurrency:
                  type: string
                  example: DEFAULT
                Year:
                  type: integer
                  description: Year for the expiry schedule
                  example: 2026
            example:
              RelationReference: jane.doe@example.com
              RelationType: 4
              ProgramId: 19
              TransactionCurrency: DEFAULT
              Year: 2026
      responses:
        '200':
          description: Expiry schedule
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: object
                    properties:
                      IsSucessful:
                        type: boolean
                      ErrorCode:
                        type: string
                      ExceptionMessage:
                        type: string
                      ReturnObject:
                        type: object
                        properties:
                          Period:
                            type: string
                            description: Expiry period type
                            example: Quarterly
                          ExpiryPeriod:
                            type: array
                            items:
                              type: object
                              properties:
                                ScheduleDate:
                                  type: string
                                  format: date-time
                                  description: Date when this batch of points expires
                                AccrualPoints:
                                  type: integer
                                  description: Points accrued in this period
                                  example: 500
                                RedeemPoints:
                                  type: integer
                                  example: 100
                                BlockedPoints:
                                  type: integer
                                  example: 0
                                TotalAvailablePoints:
                                  type: integer
                                  description: Points available after deductions
                                  example: 400
                                TotalExpiredPoints:
                                  type: integer
                                  description: >-
                                    Points that have already expired in this
                                    period
                                  example: 0
              example:
                results:
                  IsSucessful: true
                  ErrorCode: '000'
                  ExceptionMessage: Success
                  ReturnObject:
                    Period: Quarterly
                    ExpiryPeriod:
                      - ScheduleDate: '2026-03-31T00:00:00'
                        AccrualPoints: 500
                        RedeemPoints: 100
                        BlockedPoints: 0
                        TotalAvailablePoints: 400
                      - ScheduleDate: '2026-06-30T00:00:00'
                        AccrualPoints: 300
                        RedeemPoints: 50
                        BlockedPoints: 0
                        TotalAvailablePoints: 250
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT obtained from Generate Auth Token. Pass as `Authorization: bearer
        {token}`.

````