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

# Get expiration schedule

> Returns when outstanding lot-mode liability expires, in calendar-aligned buckets by asset and program. LOT-mode assets only.

Returns when outstanding value expires, aggregated from lots into calendar-aligned buckets by asset and program. Use it for breakage estimation and liability forecasting.

Buckets plus the `never_expiring`, `expiring_before_window`, and `expiring_after_window` figures sum exactly to each asset's `total_outstanding`. Applies to `LOT`-mode assets only; requesting a `SIMPLE`-mode asset returns a `400`.

<Note>
  For the lot lifecycle, see [Lots & Expiration](/guides/lots-and-expiration). For usage patterns, see the [Reporting guide](/guides/reporting).
</Note>


## OpenAPI

````yaml GET /v1/reports/expiration-schedule
openapi: 3.0.3
info:
  contact:
    email: support@scrip.dev
    name: Scrip Support
  description: >-
    Scrip is the operating system for rewards programs. Use this REST API to
    define earn and redemption rules, issue and redeem assets, and track every
    movement in a double-entry ledger. Full guides and reference:
    https://docs.scrip.dev


    Core concepts:

    - **Programs**: Containers for incentive logic (e.g., "Q1 Sales Bonus",
    "Customer Loyalty")

    - **Assets**: The currency or points being tracked (e.g., "Bonus Points",
    "Cash Rewards")

    - **Participants**: Users who earn and spend assets (identified by
    external_id)

    - **Groups**: Collections of participants for team-based incentives

    - **Rules**: Automated reward logic triggered by events

    - **Events**: Actions that trigger rule evaluation (e.g., "purchase",
    "referral")


    Response formats:

    - **Collection endpoints** return: {"data": [...], "pagination":
    {"has_more": true, "next_cursor": "..."}}

    - **Single-resource endpoints** return the resource directly

    - **Errors** return: {"code": "...", "message": "...", "details": {...}} —
    `details` is an optional object, present on input errors only
  license:
    name: Proprietary
  termsOfService: https://scrip.dev/terms
  title: Scrip API
  version: '1.0'
servers:
  - url: https://api.scrip.dev
security: []
tags:
  - description: >-
      Manage incentive programs. Programs are the top-level container for all
      incentive logic.
    name: Programs
  - description: >-
      Manage asset types (currencies, points). Assets define what participants
      can earn and spend.
    name: Assets
  - description: >-
      Manage participants and their balances. Participants are identified by
      external_id from your system.
    name: Participants
  - description: Manage participant groups for team-based incentives.
    name: Groups
  - description: >-
      Manage automated reward rules. Rules define conditions and actions
      triggered by events.
    name: Rules
  - description: Ingest events that trigger rule evaluation and reward distribution.
    name: Events
  - description: Transfer assets between participants.
    name: Transfers
  - description: Access ledger summaries and program activity reports.
    name: Reporting
  - description: >-
      Redeem participant balances for rewards. Supports raw amount redemptions
      and catalog item redemptions.
    name: Redemptions
  - description: >-
      Manage the reward catalog. Create and manage redeemable items with
      inventory tracking.
    name: Rewards
  - description: >-
      Schedule and manage automated event dispatching. Automations generate
      events on cron schedules, at specific times, or by evaluating participant
      state.
    name: Automations
  - description: >-
      Manage tier types and levels within programs. Tiers define status
      hierarchies that participants progress through based on qualification
      rules.
    name: Tiers
  - description: Inspect double-entry ledger records for auditing and reconciliation.
    name: Journal Entries
  - description: >-
      Manage webhook endpoints and delivery logs. Webhooks notify your
      application of real-time events via HTTP POST with HMAC-SHA256 signatures.
    name: Webhooks
paths:
  /v1/reports/expiration-schedule:
    get:
      tags:
        - Reporting
      summary: Get expiration schedule
      description: >-
        Returns when outstanding lot-mode liability expires, in calendar-aligned
        buckets by asset and program. LOT-mode assets only.
      operationId: getExpirationSchedule
      parameters:
        - description: Window start (inclusive, RFC3339)
          in: query
          name: from
          required: true
          schema:
            format: date-time
            type: string
        - description: Window end (inclusive, RFC3339)
          in: query
          name: to
          required: true
          schema:
            format: date-time
            type: string
        - description: 'Bucket granularity: day, week, or month (default month)'
          in: query
          name: granularity
          schema:
            default: month
            enum:
              - day
              - week
              - month
            type: string
        - description: >-
            Attribute lots to this program via their source journal entry and
            restrict to program-linked assets
          in: query
          name: program_id
          schema:
            format: uuid
            type: string
        - description: Restrict to a single LOT inventory-mode asset
          in: query
          name: asset_id
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ExpirationScheduleListResponse'
          description: Expiration schedule
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrBadRequestResponse'
          description: 'Invalid query parameters or SIMPLE-mode asset_id (code: bad_request)'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnauthorizedResponse'
          description: 'Missing or invalid credentials (code: unauthorized)'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrNotFoundResponse'
          description: 'Asset not found (code: not_found)'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrInternalResponse'
          description: 'Internal server error (code: internal_error)'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    handlers.ExpirationScheduleListResponse:
      description: Expiration schedule results
      properties:
        data:
          description: Per-asset expiration schedules (LOT inventory-mode assets only)
          items:
            $ref: '#/components/schemas/handlers.ExpirationScheduleAssetResponse'
          type: array
        pagination:
          allOf:
            - $ref: '#/components/schemas/handlers.PaginationResponse'
          description: Pagination metadata for list responses
      type: object
    handlers.ErrBadRequestResponse:
      additionalProperties: false
      properties:
        code:
          description: Code is the machine-readable error code
          example: bad_request
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: >-
            Details provides optional structured error context (field errors,
            etc.)
        message:
          description: Message is the human-readable error description
          example: Invalid request parameters
          type: string
      type: object
    handlers.ErrUnauthorizedResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unauthorized
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Missing or invalid credentials
          type: string
      type: object
    handlers.ErrNotFoundResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: not_found
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Resource not found
          type: string
      type: object
    handlers.ErrInternalResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: internal_error
          type: string
        message:
          description: Message is the human-readable error description
          example: An internal error occurred
          type: string
      type: object
    handlers.ExpirationScheduleAssetResponse:
      description: Expiration schedule for a single LOT-mode asset
      properties:
        asset_id:
          description: Unique identifier for this asset
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        asset_name:
          description: Display name for this asset
          example: Loyalty Points
          type: string
        asset_symbol:
          description: Ticker or symbol for this asset (e.g., `POINTS`)
          example: POINTS
          type: string
        attribution_adjustment:
          description: >-
            Signed program-attribution adjustment added after overdraft netting.
            It reconciles issuer-attributed lots with journal-channel
            ledger-summary attribution and is zero for organization-scoped
            results.
          example: '0.00'
          type: string
        buckets:
          description: >-
            Calendar buckets inside the window with non-zero expiring value,
            ordered by bucket_start. Empty buckets are omitted.
          items:
            $ref: '#/components/schemas/handlers.ExpirationScheduleBucketResponse'
          type: array
        expiring_after_window:
          description: Outstanding value on lots expiring after the window end
          example: '350.00'
          type: string
        expiring_before_window:
          description: >-
            Outstanding value on lots expiring before the window start,
            including lots already past expires_at that the breakage sweep has
            not yet forfeited
          example: '0.00'
          type: string
        gross_lot_outstanding:
          description: >-
            Gross remaining participant/group lot value before LOT overdraft
            netting. Reconciles as never_expiring + expiring_before_window +
            expiring_after_window + sum(buckets[].amount).
          example: '1465.00'
          type: string
        never_expiring:
          description: Outstanding value on lots with no expiration date
          example: '250.00'
          type: string
        overdraft_offset:
          description: >-
            Uncovered LOT-mode DEBIT value subtracted from
            gross_lot_outstanding. Always non-negative; positive values are
            overdraft debt.
          example: '15.00'
          type: string
        scale:
          description: Decimal scale amounts are formatted with
          example: 2
          type: integer
        total_outstanding:
          description: >-
            Posting-derived net outstanding liability for this asset. Reconciles
            as gross_lot_outstanding - overdraft_offset +
            attribution_adjustment.
          example: '1450.00'
          type: string
      type: object
    handlers.PaginationResponse:
      properties:
        has_more:
          description: Whether more results are available beyond this page
          example: true
          type: boolean
        next_cursor:
          description: Cursor to fetch the next page. Absent when there are no more results
          example: YWJjMTIz
          type: string
      type: object
    handlers.ErrorDetails:
      description: >-
        Optional structured details about the error. Always a JSON object: a
        `fields` array for validation errors, or flat
        field/reason/expected/received properties for other input errors.
      properties:
        expected:
          description: Expected value or format (non-validation input errors)
          example: uuid
          type: string
        field:
          description: Field name that caused the error (non-validation input errors)
          example: asset_id
          type: string
        fields:
          description: >-
            Fields lists each offending input field on validation_error
            responses.
          items:
            $ref: '#/components/schemas/handlers.ErrorFieldDetail'
          type: array
        reason:
          description: Machine-readable reason code (non-validation input errors)
          example: invalid
          type: string
        received:
          description: Value that was received (non-validation input errors)
          example: not-a-uuid
          type: string
      type: object
    handlers.ExpirationScheduleBucketResponse:
      description: One calendar bucket of expiring lot value
      properties:
        amount:
          description: Outstanding lot value expiring in this bucket
          example: '850.00'
          type: string
        bucket_end:
          description: 'Bucket end (exclusive): start plus one granularity unit'
          example: '2026-08-01T00:00:00Z'
          type: string
        bucket_start:
          description: Bucket start (inclusive, UTC, calendar-aligned via date_trunc)
          example: '2026-07-01T00:00:00Z'
          type: string
        lot_count:
          description: Number of lots contributing to this bucket
          example: 12
          type: integer
      type: object
    handlers.ErrorFieldDetail:
      description: >-
        A single field-level error: which input field failed, why, and (where
        known) the expected and received values.
      properties:
        expected:
          description: >-
            Expected value or format. Usually a string; for "one of" constraints
            it

            is an array of the allowed values.
        field:
          description: Field name that caused the error
          example: amount
          type: string
        message:
          description: Human-readable explanation (validation errors only)
          example: This field is required
          type: string
        reason:
          description: Machine-readable reason code
          example: required
          type: string
        received:
          description: Value that was received
          example: '-10.00'
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API key passed in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Bearer token passed in the Authorization header (e.g. "Bearer sk_...").
      in: header
      name: Authorization
      type: apiKey

````