> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Expire points

> ⚠️ **BETA endpoint**

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Manually expires an active points bucket. The bucket must be in ACTIVE status and
have a future expiration date. Both the program and member must be ACTIVE.
The card definition must have points expiration enabled.

Creates an ADMIN_POINTS_EXPIRATION transaction processed asynchronously.




## OpenAPI

````yaml /openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points/{bucketId}/expire
openapi: 3.1.0
info:
  title: Voucherify Loyalty v2 API
  version: 2.0.0
  description: >-
    Complete API documentation for Voucherify Loyalty v2 system. Requires
    LOYALTY_V2 feature flag.
servers:
  - url: https://api.voucherify.io
    description: Production
security:
  - bearerAuth: []
    X-App-Id: []
    X-App-Token: []
tags:
  - name: Card Definitions
    description: >-
      CRUD operations, lifecycle management, and activity history for card
      definitions. Card definitions describe the configuration for loyalty
      cards, including code generation, points expiration, earning/spending
      limits, pending points, refunds, and balance settings.
  - name: Programs
    description: >-
      Loyalty program CRUD, lifecycle management, program-scoped resource
      assignments (card definitions, earning rules, rewards, tier structures),
      member management (create, list, get, activate, deactivate, delete), card
      operations (points adjustment, pending points, expiring points,
      transactions), reward purchases, and activity history.
  - name: Earning Rules
    description: >-
      Manage earning rules that define how customers earn points or receive
      incentives based on triggers (events, segments, custom events). Includes
      CRUD, lifecycle, and activity history.
  - name: Tier Structures
    description: >-
      CRUD operations, lifecycle management, and activity history for tier
      structures. Includes nested tier definitions (create, list, update,
      delete) within tier structures. Tier structures define the tiering model
      for loyalty programs — how members qualify for and move between tiers.
  - name: Incentives
    description: >-
      Manage incentive definitions (fixed points, proportional points, material,
      digital). Includes CRUD, lifecycle transitions, and activity history.
  - name: Rewards
    description: >-
      CRUD, lifecycle operations, and activity history for reward definitions.
      Rewards can be material (product/SKU) or digital (discount coupons, gift
      vouchers).
  - name: Examine
    description: Examines the earning of loyalty points for a loyalty program member.
paths:
  /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points/{bucketId}/expire:
    post:
      tags:
        - Programs
      summary: Expire points
      description: >
        ⚠️ **BETA endpoint**


        This is a work-in-progress documentation of a BETA endpoint. The
        parameters, fields, request and response bodies, and other data may
        subject to change. If you want to share feedback or improvements,
        contact Voucherify support or your Technical Account Manager.


        Manually expires an active points bucket. The bucket must be in ACTIVE
        status and

        have a future expiration date. Both the program and member must be
        ACTIVE.

        The card definition must have points expiration enabled.


        Creates an ADMIN_POINTS_EXPIRATION transaction processed asynchronously.
      operationId: expirePoints
      parameters:
        - $ref: '#/components/parameters/MemberProgramId'
        - $ref: '#/components/parameters/MemberId'
        - $ref: '#/components/parameters/CardId'
        - $ref: '#/components/parameters/BucketId'
      responses:
        '200':
          description: Points expiration result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PointsExpirationResponse'
        '404':
          $ref: '#/components/responses/NotFound'
        '423':
          description: |
            One of:
            - Program or member is not in ACTIVE status
            - Points expiration not enabled on card definition
            - Bucket is not in ACTIVE status
            - Bucket expiration date is not in the future
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    MemberProgramId:
      name: programId
      in: path
      required: true
      description: Unique program identifier
      schema:
        type: string
    MemberId:
      name: memberId
      in: path
      required: true
      description: Unique member identifier
      schema:
        type: string
    CardId:
      name: cardId
      in: path
      required: true
      description: Unique card identifier
      schema:
        type: string
    BucketId:
      name: bucketId
      in: path
      required: true
      description: Unique bucket identifier (pending points or expiring points)
      schema:
        type: string
  schemas:
    PointsExpirationResponse:
      type: object
      description: Result of a manual points expiration operation
      properties:
        status:
          type: string
          enum:
            - TRANSACTION_CREATED
            - NO_EXPIRATION
        message:
          type: string
          description: Human-readable result message
          examples:
            - Points expiration transaction created
        transaction:
          oneOf:
            - $ref: '#/components/schemas/CardTransaction'
            - type: 'null'
    ErrorResponse:
      type: object
      description: Standard error response.
      properties:
        code:
          type: integer
          description: HTTP status code.
        key:
          type: string
          description: Machine-readable error key.
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional error details.
        request_id:
          type:
            - string
            - 'null'
          description: Request identifier for tracing.
        resource_id:
          type: string
          description: Related resource identifier (when applicable).
        resource_type:
          type: string
          description: Related resource type (when applicable).
      required:
        - code
        - key
        - message
    CardTransaction:
      type: object
      description: A card transaction recording a points operation
      properties:
        id:
          type: string
          description: Unique transaction identifier
        card_id:
          type: string
          description: Card this transaction belongs to
        program_id:
          type: string
          description: Program identifier
        member_id:
          type: string
          description: Member identifier
        card_definition_id:
          type: string
          description: Card definition identifier
        card_type:
          type: string
          description: Card type
        type:
          type: string
          enum:
            - ADMIN_CREDIT
            - ADMIN_DEBIT
            - ADMIN_POINTS_EXPIRATION
            - POINTS_EARNED
            - POINTS_SPENT_ON_REWARD
            - POINTS_REFUNDED
            - POINTS_RETURNED
            - POINTS_EXPIRED
            - PENDING_POINTS_ADDED
            - PENDING_POINTS_ACTIVATED
            - PENDING_POINTS_CANCELED
          description: Type of transaction
        details:
          $ref: '#/components/schemas/CardTransactionDetails'
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - APPROVED
            - REJECTED
          description: Transaction processing status
        created_at:
          type: string
          format: date-time
          description: ISO 8601 creation timestamp
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO 8601 last update timestamp
    CardTransactionDetails:
      type: object
      description: >
        Transaction details vary by transaction type.

        All types include `reason` (string or null), `metadata` (object), and
        optionally `rejection`.
      properties:
        reason:
          type:
            - string
            - 'null'
          description: Reason for the transaction
        metadata:
          type: object
          description: Custom metadata
          additionalProperties: true
        rejection:
          oneOf:
            - $ref: '#/components/schemas/CardTransactionRejection'
            - type: 'null'
          description: Rejection details (only present for REJECTED transactions)
        points:
          type: object
          description: Points details (present for most transaction types)
          properties:
            total:
              type: integer
              description: Total points in this transaction
            expiration_date:
              type:
                - string
                - 'null'
              format: date
              description: Points expiration date (ADMIN_CREDIT, POINTS_EARNED)
            expiration_type:
              type:
                - string
                - 'null'
              description: Points expiration type (ADMIN_CREDIT, POINTS_EARNED)
            date:
              type:
                - string
                - 'null'
              format: date
              description: Activation/cancellation date (PENDING_POINTS_* types)
            type:
              type:
                - string
                - 'null'
              description: Pending points type (PENDING_POINTS_* types)
        result:
          type:
            - object
            - 'null'
          description: Result details (POINTS_SPENT_ON_REWARD)
          additionalProperties: true
        reward_id:
          type:
            - string
            - 'null'
          description: Associated reward ID (POINTS_SPENT_ON_REWARD)
        bucket:
          type:
            - object
            - 'null'
          description: Associated points bucket details (ADMIN_POINTS_EXPIRATION)
          additionalProperties: true
    CardTransactionRejection:
      type: object
      description: Details about why a transaction was rejected
      properties:
        reason:
          type: string
          description: Rejection reason
        details:
          type: string
          description: Detailed rejection information
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    X-App-Id:
      type: apiKey
      name: X-App-Id
      in: header
    X-App-Token:
      type: apiKey
      name: X-App-Token
      in: header

````