# Show Member Rewards Program Status

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v3/{loyalty_club_slug}/members/me/rewards-program/status:
    get:
      summary: Show Member Rewards Program Status
      deprecated: false
      description: Returns Rewards Program status for current member.
      tags:
        - API Reference/Public API/Rewards/Rewards Program
      parameters:
        - name: loyalty_club_slug
          in: path
          description: ''
          required: true
          example: infinity-mall
          schema:
            type: string
        - name: per_page
          in: query
          description: >-
            Number of results to be returned per request. See: [API
            Pagination](doc-341638)
          example: 10
          schema:
            type: integer
            default: '10'
        - name: page_no
          in: query
          description: 'Number of results page. See: [API Pagination](doc-341638)'
          example: 1
          schema:
            type: integer
            minimum: 1
            default: '1'
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  membership:
                    type: boolean
                  membership_started_at: &ref_0
                    $ref: '#/components/schemas/date_time'
                  balance:
                    type: integer
                    minimum: 0
                  level:
                    type: string
                    nullable: true
                  earned_points_total:
                    type: integer
                    minimum: 0
                  closest_reward:
                    $ref: '#/components/schemas/AvailableReward'
                  transactions:
                    type: array
                    items:
                      $ref: '#/components/schemas/MemberTransaction'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                x-apidog-orders:
                  - membership
                  - membership_started_at
                  - balance
                  - level
                  - earned_points_total
                  - closest_reward
                  - transactions
                  - pagination_info
                required:
                  - membership
                  - membership_started_at
                  - balance
                  - level
                  - earned_points_total
                  - closest_reward
                  - transactions
                  - pagination_info
                x-apidog-ignore-properties: []
              example:
                membership: true
                membership_started_at: '2022-11-09T16:25:58.099512Z'
                balance: 2000
                level: null
                earned_points_total: 3000
                closest_reward:
                  name: Free Parking
                  description: >-
                    Creta debilito celo venia abscido sapiente deprimo
                    chirographum porro. Venio veritas varietas nisi amicitia.
                    Virga xiphias cicuta. Conitor conculco dapifer. Depopulo
                    coaegresco clam nam vorax videlicet terebro dicta vulgus
                    caelum.
                  files:
                    - url: https://salty-cutover.info/
                      width: 99835844
                      height: -38874308
                      kind: culpa consectetur fugiat
                      size_type: sit consectetur dolore proident
                    - url: https://upset-dime.name/
                      width: 78310778
                      height: -17782076
                      kind: nisi
                      size_type: commodo ad
                    - url: https://oval-yarmulke.biz/
                      width: 87397571
                      height: -28079565
                      kind: eiusmod
                      size_type: minim cupidatat
                  price: 540
                  remaining_stock: 100
                  available_until: null
                  usable_after_purchase_for: 68298332
                transactions:
                  - id: 40742241
                    type: reward_purchase
                    date: '2022-11-09T16:25:58.099512Z'
                    amount: 505
                    expired_at: null
                    cancelled_at: null
                    details:
                      reward_name: Keith Wilkinson
                  - id: 25004706
                    type: expiration
                    date: '2022-11-09T16:25:58.099512Z'
                    amount: 86
                    expired_at: '2022-11-09T16:25:58.099512Z'
                    cancelled_at: '2022-11-09T16:25:58.099512Z'
                    details:
                      comment: elit enim aliquip quis minim
                pagination_info:
                  total_count: 2050
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Public API/Rewards/Rewards Program
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510876-run
components:
  schemas:
    PaginationInfo:
      type: object
      properties:
        count:
          type: integer
          description: Actual number of results returned in request
          readOnly: true
          examples:
            - 1000
        total_count:
          type: integer
          description: Number of all available results
          minimum: 1
          examples:
            - 2050
        per_page:
          type: integer
          description: Number of results returned per request
          readOnly: true
          examples:
            - 1000
        total_pages:
          type: integer
          description: Number of all available pages
          readOnly: true
          examples:
            - 3
        current_page:
          type: integer
          readOnly: true
          examples:
            - 1
        next_page:
          type: integer
          description: Next available page (null when it's a last page)
          readOnly: true
          examples:
            - 2
          nullable: true
        prev_page:
          type: integer
          description: Next available page (null when it's a first page)
          readOnly: true
          examples:
            - null
          nullable: true
        is_first_page:
          type: boolean
          readOnly: true
          examples:
            - true
        is_last_page:
          type: boolean
          readOnly: true
          examples:
            - false
        is_out_of_range:
          type: boolean
          description: Is given `per_page` param out of range?
          readOnly: true
          examples:
            - false
        offset:
          type: integer
          readOnly: true
          examples:
            - 0
      required:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      x-apidog-orders:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    MemberTransaction:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        type:
          type: string
          enum:
            - achievement
            - reward_purchase
            - expiration
            - correction
          x-apidog-enum:
            - value: achievement
              name: ''
              description: ''
            - value: reward_purchase
              name: ''
              description: ''
            - value: expiration
              name: ''
              description: ''
            - value: correction
              name: ''
              description: ''
          description: >-
            type of transaction - see [Transaction
            types](doc-341651#transaction-types)
        date: *ref_0
        amount:
          type: integer
          description: How many points the transaction added or subtracted
        expired_at:
          anyOf:
            - *ref_0
            - type: 'null'
          description: >-
            (optional) When the points granted by the transaction expired. When
            null, they're not expired
        cancelled_at:
          anyOf:
            - *ref_0
            - type: 'null'
          description: >-
            (optional) When the points granted by the transaction are cancelled.
            When null, they're not cancelled
        details:
          oneOf:
            - type: object
              properties:
                achievement_type:
                  type: string
                  description: >-
                    Type of achievement that granted the points - see
                    [Achievement types](doc-341651#achievement-types)
                rule_id:
                  type: integer
                  minimum: 1
                  description: ID of achievement/rule
                event_id:
                  type: string
                  nullable: true
              x-apidog-orders:
                - achievement_type
                - rule_id
                - event_id
              required:
                - achievement_type
                - rule_id
                - event_id
              description: achievement
              x-apidog-ignore-properties: []
            - type: object
              properties:
                reward_name:
                  type: string
                  description: Name of reward that the points have been spent on
              x-apidog-orders:
                - reward_name
              description: reward_purchase
              required:
                - reward_name
              x-apidog-ignore-properties: []
            - type: object
              properties:
                comment:
                  type: string
                  description: (optional) Admin's notes
                  nullable: true
              x-apidog-orders:
                - comment
              description: correction
              x-apidog-ignore-properties: []
            - type: object
              properties:
                grant_type:
                  type: string
                  nullable: true
                grant_properties:
                  type: object
                  properties: {}
                  x-apidog-orders: []
                  x-apidog-ignore-properties: []
                  nullable: true
              x-apidog-orders:
                - grant_type
                - grant_properties
              description: grant
              x-apidog-ignore-properties: []
            - type: object
              properties:
                cancelled_transaction_id:
                  type: integer
                  minimum: 1
                  description: (optional) ID of cancelled transaction
                  nullable: true
              x-apidog-orders:
                - cancelled_transaction_id
              description: cancellation
              x-apidog-ignore-properties: []
          description: >-
            Transaction type specific details  - see [Transaction
            types](doc-341651#transaction-types)
      x-apidog-orders:
        - id
        - type
        - date
        - amount
        - expired_at
        - cancelled_at
        - details
      required:
        - id
        - type
        - date
        - amount
        - expired_at
        - cancelled_at
        - details
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    AvailableReward:
      type: object
      properties:
        id: &ref_1
          $ref: '#/components/schemas/id'
          description: Primary identifier of the record
          readOnly: true
        name:
          type: string
          title: ''
          examples:
            - Free Parking
          nullable: true
        description:
          type: string
          nullable: true
        files:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
              width:
                type: integer
              height:
                type: integer
              kind:
                type: string
              size_type:
                type: string
            required:
              - url
              - width
              - height
              - kind
              - size_type
            x-apidog-orders:
              - url
              - width
              - height
              - kind
              - size_type
            x-apidog-ignore-properties: []
          description: A list of Reward Files - see [File model](doc-341697#file-model)
        price:
          type: integer
          description: Number of points that must be spent to purchase the reward
          minimum: 0
          examples:
            - 540
        remaining_stock:
          type: integer
          description: >-
            Number of items that is available for purchase. When null, there is
            no limit.
          minimum: 0
          examples:
            - 100
          nullable: true
        available_until:
          description: >-
            Date until the reward may be purchased. When null, there is no
            availability limit.
          anyOf:
            - *ref_0
            - type: 'null'
        usable_after_purchase_for:
          type: integer
          description: >-
            Time (in seconds) that specifies how long the offer will be usable
            after purchase. When null, there is no limit
          minimum: 0
          nullable: true
      required:
        - id
        - name
        - description
        - files
        - price
        - remaining_stock
        - available_until
        - usable_after_purchase_for
      x-apidog-orders:
        - 01K6ATGWWTT07S2HRAWDTEMYM6
        - name
        - description
        - files
        - price
        - remaining_stock
        - available_until
        - usable_after_purchase_for
      x-apidog-refs:
        01K6ATGWWTT07S2HRAWDTEMYM6:
          $ref: '#/components/schemas/id1'
      x-apidog-ignore-properties:
        - id
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
    id1:
      type: object
      properties:
        id: *ref_1
      x-apidog-orders:
        - id
      required:
        - id
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date_time:
      type: string
      format: date-time
      examples:
        - '2022-11-09T16:25:58.099512Z'
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```