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

# Get point balance

> The diner's points in the channel's point program. `value` is what the points are worth, in cents. Expiring points are those that expire in the next month.

If the channel has no point program, every field is `0`.




## OpenAPI

````yaml specs/accounts-v1.yaml GET /point_balance
openapi: 3.1.0
info:
  title: Atlas Accounts API
  version: 1.0.0
  description: ''
servers:
  - url: https://api.atlas.kitchen/accounts/v1
    description: Accounts API
security:
  - channelId: []
    sessionId: []
tags:
  - name: Introduction
    description: >
      The Accounts API lets a diner sign in on your storefront, then read and
      manage their own account with the merchant: profile, saved addresses, past
      orders, points and wallet promotions.


      It uses the same `X-Channel-Id` and `X-Session-Id` headers as the
      [Storefront API](/connect/storefront-api/authentication). Signing in
      attaches the diner to the session, so the Storefront API cart can use and
      earn their points.


      Everything here belongs to one merchant. The channel decides the merchant,
      and the merchant's point program for the channel's brand decides the
      points. The same diner can have different balances with different
      merchants.
  - name: Sign in
    description: Request a one-time code and sign the diner in.
  - name: Profile
    description: The signed-in diner's details.
  - name: Addresses
    description: Delivery addresses the signed-in diner has saved.
  - name: Orders
    description: The signed-in diner's past orders with this merchant.
  - name: Loyalty
    description: The signed-in diner's points and wallet promotions.
paths:
  /point_balance:
    get:
      tags:
        - Loyalty
      summary: Get point balance
      description: >
        The diner's points in the channel's point program. `value` is what the
        points are worth, in cents. Expiring points are those that expire in the
        next month.


        If the channel has no point program, every field is `0`.
      operationId: getPointBalance
      responses:
        '200':
          description: The diner's balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  points:
                    type: integer
                  value:
                    type: number
                    description: Worth of `points`, in cents
                  expiring_points:
                    type: integer
                    description: Points that expire in the next month
                  expiring_value:
                    type: number
                    description: Worth of `expiring_points`, in cents
              example:
                points: 540
                value: 540
                expiring_points: 40
                expiring_value: 40
        '401':
          description: >
            No diner is signed in on this session: `{"error": "Unauthorized"}`.
            A missing or invalid session ID returns the usual error body
            instead.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: string
                  - $ref: '#/components/schemas/Error'
              example:
                error: Unauthorized
components:
  schemas:
    Error:
      type: object
      properties:
        type:
          type: string
          example: Invalid Parameter
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  securitySchemes:
    channelId:
      type: apiKey
      in: header
      name: X-Channel-Id
      description: Merchant storefront identifier. Provided during onboarding.
    sessionId:
      type: apiKey
      in: header
      name: X-Session-Id
      description: >-
        Diner session identifier from the Storefront API's `GET /channel`. Log
        in returns a new one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.