> ## 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.

# List program spending summary reports

> Returns all-time point-spending totals for the program, one row per card definition that has recorded spending. Filters rows with `filters[card_definition_id]`. Returns at most 10 rows (max number of card definitions per program), ordered by `id` descending. `limit` and `order` are not query parameters.

Returns `200` with an empty `data` array when no spending is recorded. Returns `400` when query validation fails. Returns `404` when the program does not exist.



## OpenAPI

````yaml /openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/spending/summary
openapi: 3.1.0
info:
  title: Voucherify Loyalty v2 API
  version: 2.0.0
  description: >-
    Complete OpenAPI specification for the Voucherify Loyalty v2 API.

    All endpoints require the LOYALTY_V2 feature flag.


    Combined from per-domain specs: programs.yaml, members.yaml,
    program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
    tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
  - url: '{protocol}://{host}'
    variables:
      protocol:
        default: https
        enum:
          - https
          - http
      host:
        default: api.voucherify.io
security:
  - X-App-Id: []
    X-App-Token: []
  - bearerAuth: []
tags:
  - name: Programs
    description: >-
      Loyalty program CRUD, lifecycle management, program-scoped resource
      assignments (card definitions, earning rules, rewards, tier structures),
      member management (create, list, get, update, activate, deactivate,
      delete), membership retrieval (member + program + cards with tier
      progress, by customer ID, customer source ID, or member ID), card
      operations (points adjustment, pending points, expiring points,
      transactions), reward purchases, and activity history.
  - 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: 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: Benefits
    description: >-
      Manage benefit 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: >-
      Evaluation endpoints that estimate earning opportunities and reward
      availability for a customer across their loyalty program memberships,
      without side effects.
paths:
  /v2/loyalties/programs/{programId}/reports/spending/summary:
    parameters:
      - name: programId
        in: path
        required: true
        description: >-
          Unique loyalty program identifier (format: `lprg_` followed by
          hexadecimal characters).
        schema:
          type: string
    get:
      tags:
        - Programs
      summary: List program spending summary reports
      description: >-
        Returns all-time point-spending totals for the program, one row per card
        definition that has recorded spending. Filters rows with
        `filters[card_definition_id]`. Returns at most 10 rows (max number of
        card definitions per program), ordered by `id` descending. `limit` and
        `order` are not query parameters.


        Returns `200` with an empty `data` array when no spending is recorded.
        Returns `400` when query validation fails. Returns `404` when the
        program does not exist.
      operationId: listProgramSpendingSummaryReports
      parameters:
        - name: filters
          in: query
          required: false
          style: deepObject
          explode: true
          description: >-
            Filters rows by field conditions, e.g.
            `filters[card_definition_id][conditions][$is]=lcdef_...`.
          schema:
            $ref: '#/components/schemas/SpendingReportListFilters'
      responses:
        '200':
          description: Program spending summary report.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/LoyaltiesProgramsReportsSpendingSummaryListResponseBody
              examples:
                Summary spending report:
                  value:
                    data:
                      - id: lssum_12c2bc3be20c8cb533
                        card_definition_id: lcdef_128f495f720c4bec8c
                        success: 1
                        success_on_reward: 1
                        success_on_order: 0
                        points: 250
                        points_on_rewards: 250
                        points_on_order: 0
                        amount_on_order: 0
                        object: spending_summary_report
                      - id: lssum_12a8242827ca244ecd
                        card_definition_id: lcdef_128f4a88414c4bed69
                        success: 30
                        success_on_reward: 10
                        success_on_order: 20
                        points: 7943
                        points_on_rewards: 5000
                        points_on_order: 2943
                        amount_on_order: 2943
                        object: spending_summary_report
                    object: report
                Empty spending summary report:
                  value:
                    data: []
                    object: report
        '400':
          description: Query parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                'Invalid query parameters: `card_definition_id` is invalid':
                  value:
                    code: 400
                    key: invalid_query_params
                    message: Invalid query params
                    details: >-
                      Property .filters.card_definition_id.conditions.$is must
                      match pattern "^lcdef_[a-f0-9]+$"
                    request_id: v-131e4b76ad2e098945
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Program not found:
                  value:
                    code: 404
                    key: not_found
                    message: Resource not found
                    details: Cannot find program with id lprg_128f58429fc4bf7b2
                    request_id: v-131e4b76ad2e098944
                    resource_id: lprg_128f58429fc4bf7b2
                    resource_type: program
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal server error:
                  value:
                    code: 500
                    key: api_error
                    message: >-
                      Something went wrong. Don't worry, your campaigns are
                      still safe and the Voucherify Team has been notified.
                      Check out our Help Center and forums for help, or head
                      back to home.
components:
  schemas:
    SpendingReportListFilters:
      type: object
      description: Filters for spending reports.
      properties:
        junction:
          description: >-
            Sets the logical junction between field filters. Allowed values:
            `AND`, `OR`. Defaults to `AND`.
          oneOf:
            - type: string
              enum:
                - AND
                - OR
            - type: 'null'
        card_definition_id:
          description: Filters rows by card definition id (`lcdef_...`).
          oneOf:
            - $ref: >-
                #/components/schemas/SpendingReportFilterCardDefinitionIdConditions
            - type: 'null'
      additionalProperties: false
    LoyaltiesProgramsReportsSpendingSummaryListResponseBody:
      type: object
      title: Loyalties Programs Reports Spending Summary List Response Body
      description: >-
        Response body schema for **GET**
        `/v2/loyalties/programs/{programId}/reports/spending/summary`.
      properties:
        data:
          type: array
          description: >-
            Lists summary rows, one per card definition that has recorded
            spending. Contains at most 10 rows (max number of card definitions
            per program), ordered by `id` descending.
          items:
            $ref: '#/components/schemas/SpendingReportSummaryEntry'
        object:
          type: string
          const: report
          description: Object type marker. Always `report`.
      required:
        - data
        - object
    ErrorResponse:
      type: object
      description: Standard error response returned by all Loyalty v2 endpoints.
      properties:
        code:
          type: integer
          description: HTTP status code of the error.
        key:
          type: string
          description: Machine-readable error key.
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional details about the error.
        request_id:
          type: string
          description: Unique identifier of the request that produced the error.
        resource_id:
          type: string
          description: Unique identifier of the resource that produced the error.
        resource_type:
          type: string
          description: Type of the resource that produced the error.
    SpendingReportFilterCardDefinitionIdConditions:
      type: object
      description: >-
        ID filter conditions for card definition ids. Values must match pattern
        `^lcdef_[a-f0-9]+$`. `$is`/`$is_not` accept a single value (string or
        1-element array); `$in`/`$not_in` accept a string or an array of 1-100
        values.
      properties:
        conditions:
          type: object
          minProperties: 1
          additionalProperties: false
          properties:
            $is:
              description: Matches rows whose card definition id equals the given value.
              oneOf:
                - type: string
                  pattern: ^lcdef_[a-f0-9]+$
                - type: array
                  items:
                    type: string
                    pattern: ^lcdef_[a-f0-9]+$
                  minItems: 1
                  maxItems: 1
                - type: 'null'
            $is_not:
              description: >-
                Matches rows whose card definition id does not equal the given
                value.
              oneOf:
                - type: string
                  pattern: ^lcdef_[a-f0-9]+$
                - type: array
                  items:
                    type: string
                    pattern: ^lcdef_[a-f0-9]+$
                  minItems: 1
                  maxItems: 1
                - type: 'null'
            $in:
              description: >-
                Matches rows whose card definition id is one of the given
                values.
              oneOf:
                - type: string
                  pattern: ^lcdef_[a-f0-9]+$
                - type: array
                  items:
                    type: string
                    pattern: ^lcdef_[a-f0-9]+$
                  minItems: 1
                  maxItems: 100
                - type: 'null'
            $not_in:
              description: >-
                Matches rows whose card definition id is not one of the given
                values.
              oneOf:
                - type: string
                  pattern: ^lcdef_[a-f0-9]+$
                - type: array
                  items:
                    type: string
                    pattern: ^lcdef_[a-f0-9]+$
                  minItems: 1
                  maxItems: 100
                - type: 'null'
      required:
        - conditions
      additionalProperties: false
    SpendingReportSummaryEntry:
      type: object
      description: >-
        Total program spending statistics for one card definition that has
        recorded spending. Numeric fields default to `0`.
      properties:
        id:
          type: string
          description: Identifies the summary row (`lssum_...`).
        card_definition_id:
          type: string
          description: Identifies the card definition (`lcdef_...`).
        success:
          type: number
          description: Counts successful spending operations.
        success_on_reward:
          type: number
          description: Counts successful reward purchases.
        success_on_order:
          type: number
          description: Counts successful order payments.
        points:
          type: number
          description: Totals points spent.
        points_on_rewards:
          type: number
          description: Totals points spent on reward purchases.
        points_on_order:
          type: number
          description: Totals points spent on order payments.
        amount_on_order:
          type: number
          description: Totals order amount paid with points.
        object:
          type: string
          const: spending_summary_report
          description: Object type marker. Always `spending_summary_report`.
      required:
        - id
        - card_definition_id
        - success
        - success_on_reward
        - success_on_order
        - points
        - points_on_rewards
        - points_on_order
        - amount_on_order
        - object
  securitySchemes:
    X-App-Id:
      type: apiKey
      name: X-App-Id
      in: header
    X-App-Token:
      type: apiKey
      name: X-App-Token
      in: header
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````