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

# Rewards status

> Get the authenticated customer's current rewards status, including points balance, current and next tier, progress and redemption information. When the rewards programme is disabled for the tenant, only `enabled: false` is returned.

Note: `/account/membership/*` is a deprecated alias of `/account/rewards/*` and maps to the same endpoints; use `/account/rewards/*` for new integrations.



## OpenAPI

````yaml /api-reference/openapi.json get /account/rewards/status
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
  - name: Settings
    description: >-
      Storefront settings and market detection used to configure the web
      components and checkout.
  - name: Analytics
    description: Storefront visit and attribution tracking.
  - name: Rewards
    description: >-
      Loyalty and rewards programme endpoints for the authenticated customer,
      covering points balance, tier status, perks, exclusive products and
      transaction history.
  - name: Forms
    description: Render and submit dynamic storefront forms defined in the CMS.
  - name: Events
    description: >-
      Check event availability, browse occurrences and recurring dates, generate
      ticket QR codes, and manage event waitlists (join, leave, check status,
      and claim promoted spots).
paths:
  /account/rewards/status:
    parameters: []
    get:
      tags:
        - Rewards
      summary: Rewards status
      description: >-
        Get the authenticated customer's current rewards status, including
        points balance, current and next tier, progress and redemption
        information. When the rewards programme is disabled for the tenant, only
        `enabled: false` is returned.


        Note: `/account/membership/*` is a deprecated alias of
        `/account/rewards/*` and maps to the same endpoints; use
        `/account/rewards/*` for new integrations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RewardStatus'
              example:
                data:
                  enabled: true
                  subscribersOnly: false
                  subscribersOnlyMessage: null
                  subscribersOnlyButtonText: null
                  subscriptionsUrl: null
                  isSubscriber: true
                  points: 320
                  currentTier:
                    id: 3f0d5a2c-1111-2222-3333-444455556666
                    name: Silver
                    slug: silver
                    description: Silver tier members
                    badgeColor: '#C0C0C0'
                    badgeIcon: star
                    pointsThreshold: 100
                  totalPoints: 320
                  lifetimePoints: 540
                  nextTier:
                    id: 7a1e9b3d-7777-8888-9999-000011112222
                    name: Gold
                    slug: gold
                    badgeColor: '#FFD700'
                    pointsThreshold: 750
                    pointsNeeded: 210
                    progressPercent: 72
                  redemption:
                    enabled: true
                    rate: 100
                    rateDescription: 100 points = £1
                    currencyCode: GBP
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Unauthenticated.
      security:
        - accountAuth: []
components:
  schemas:
    RewardStatus:
      type: object
      description: >-
        Customer rewards status. When the programme is disabled only `enabled`
        is present.
      properties:
        enabled:
          type: boolean
          description: Whether the rewards programme is enabled for the tenant
        subscribersOnly:
          type: boolean
          description: Whether rewards are restricted to subscribers
        subscribersOnlyMessage:
          type: string
          nullable: true
        subscribersOnlyButtonText:
          type: string
          nullable: true
        subscriptionsUrl:
          type: string
          nullable: true
          description: Path to the subscriptions page when rewards are subscribers-only
        isSubscriber:
          type: boolean
          description: Whether the customer has an active subscription
        points:
          type: integer
          description: Current points balance
        currentTier:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            slug:
              type: string
            description:
              type: string
              nullable: true
            badgeColor:
              type: string
              nullable: true
            badgeIcon:
              type: string
              nullable: true
            pointsThreshold:
              type: integer
        totalPoints:
          type: integer
          description: Current points balance
        lifetimePoints:
          type: integer
          description: Lifetime points earned
        nextTier:
          type: object
          nullable: true
          description: Progress toward the next tier
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            slug:
              type: string
            badgeColor:
              type: string
              nullable: true
            pointsThreshold:
              type: integer
            pointsNeeded:
              type: integer
              description: Points still needed to reach the next tier
            progressPercent:
              type: number
              description: Percentage progress toward the next tier
        redemption:
          type: object
          nullable: true
          description: Points redemption info, present only when redemption is enabled
          properties:
            enabled:
              type: boolean
            rate:
              type: number
              nullable: true
              description: Points required per unit of currency
            rateDescription:
              type: string
              nullable: true
            currencyCode:
              type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message
      required:
        - message
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT
    accountAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is the account token returned from the `Login` endpoint.

````