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

# List bills

> Returns all linked bills for the authenticated user.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json get /v1/bills/
openapi: 3.0.3
info:
  title: Spritz Finance API
  version: 1.0.0
  description: API for the Spritz Finance platform with RFC 9457 error handling
servers:
  - url: https://platform.spritz.finance
    description: Production
  - url: https://sandbox.spritz.finance
    description: Sandbox
security: []
tags:
  - name: Users
    description: User management endpoints
  - name: Bank Accounts
    description: Manage bank accounts for off-ramp destinations
  - name: Bills
    description: Manage bill pay accounts
  - name: Cards
    description: Spritz-issued debit cards
  - name: Auto-Ramp Accounts
    description: Virtual bank accounts that automatically convert fiat deposits to crypto
  - name: Spritz App
    description: >-
      Endpoints used by the Spritz app and internal SDKs. Excluded from the
      public partner spec.
paths:
  /v1/bills/:
    get:
      tags:
        - Bills
      summary: List bills
      description: Returns all linked bills for the authenticated user.
      operationId: getV1Bills
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      description: Unique identifier for the bill
                      type: string
                    status:
                      type: string
                      enum:
                        - active
                        - pending
                        - inactive
                        - rejected
                        - action_required
                    name:
                      description: Provider bill name or generated fallback label
                      type: string
                      example: Chase Sapphire Card
                    institution:
                      description: Financial institution details
                      type: object
                      properties:
                        name:
                          description: Name of the financial institution
                          type: string
                          example: Chase
                        logo:
                          description: URL to institution logo
                          type: string
                          example: https://example.com/chase-logo.png
                      required:
                        - name
                    type:
                      type: string
                      enum:
                        - auto_loan
                        - credit_card
                        - loan
                        - mobile_phone
                        - mortgage
                        - student_loan
                        - utility
                        - unknown
                    accountNumberLast4:
                      description: Last 4 digits of the bill account number
                      type: string
                      example: '1234'
                    currency:
                      type: string
                      enum:
                        - USD
                        - CAD
                        - EUR
                        - GBP
                    liability:
                      description: >-
                        Liability data from the bill provider. All fields are
                        optional and amounts are decimal strings.
                      type: object
                      properties:
                        balance:
                          description: Current outstanding balance
                          type: string
                          example: '1234.56'
                        statementBalance:
                          description: Most recent statement balance
                          type: string
                          example: '1100.00'
                        minimumPayment:
                          description: Minimum payment due
                          type: string
                          example: '25.00'
                        lastPaymentAmount:
                          description: Amount of the last payment made
                          type: string
                          example: '150.00'
                        lastPaymentDate:
                          description: Date of the last payment
                          format: date
                          type: string
                          example: '2025-03-01'
                        nextPaymentDueDate:
                          description: Date the next payment is due
                          format: date
                          type: string
                          example: '2025-04-01'
                        amountDue:
                          description: Amount currently due
                          type: string
                          example: '0.00'
                    requirements:
                      description: >-
                        Actions the user must complete before the bill is
                        payable. Present (non-empty) when status is
                        action_required.
                      type: array
                      items:
                        description: >-
                          An action the user must complete before the bill can
                          be paid.
                        type: object
                        properties:
                          type:
                            description: >-
                              The action the user must complete to make the bill
                              payable
                            type: string
                            example: card_details
                          fields:
                            description: >-
                              Fields the user must supply to satisfy the
                              requirement
                            type: array
                            items:
                              type: string
                            example:
                              - credit_card_number
                          reason:
                            description: Human-readable explanation of the requirement
                            type: string
                            example: This card is expired
                        required:
                          - type
                    unpayableCode:
                      type: string
                      enum:
                        - institution_not_supported
                        - account_number_invalid
                        - account_verification_failed
                        - not_supported
                    createdAt:
                      description: When the bill was linked
                      format: date-time
                      type: string
                  required:
                    - id
                    - status
                    - name
                    - type
                    - currency
                    - createdAt
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 401
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                    example: Bearer token required
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  realm:
                    description: The authentication realm
                    type: string
                    example: API
                  scope:
                    description: The required scope for this resource
                    type: string
                    example: read:users
                required:
                  - title
                  - status
                additionalProperties: false
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                  status:
                    description: The HTTP status code
                    type: number
                    example: 404
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  resourceType:
                    description: The type of resource that was not found
                    type: string
                    example: user
                  resourceId:
                    description: The identifier of the resource that was not found
                    type: string
                required:
                  - title
                  - status
                  - resourceType
                  - resourceId
                additionalProperties: false
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 400
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                    example: /errors/1234567890
                  code:
                    description: >-
                      Machine-readable cause, present when exactly one thing
                      failed. Branch on this, never on `detail`, which is
                      human-facing copy and may change. For deposit limits the
                      vocabulary matches the `reason` values the limits API
                      returns pre-flight.
                    type: string
                    example: transaction_limit
                  field:
                    description: The offending request field, present alongside `code`.
                    type: string
                    example: amountUsd
                  retryable:
                    description: >-
                      Whether retrying the same request later may succeed
                      without changing its inputs.
                    type: boolean
                    example: true
                required:
                  - title
                  - status
                additionalProperties: false
      security:
        - bearerAuth: []
        - integratorJwt: []
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication
    integratorJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Integrator JWT token (prefix: spr_) for frontend integrator
        authentication. Obtained via token exchange endpoint.
    hmacAuth:
      type: apiKey
      in: header
      name: X-Signature
      description: >-
        HMAC signature authentication for backend integrators.


        **Required Headers:**

        - X-Integrator-Key: Integrator API key (format: int_...)

        - X-Signature: HMAC signature (format: sha256={hex})

        - X-Timestamp: Unix timestamp in milliseconds

        - Authorization: Bearer {user-api-key}


        **Signature Algorithm:** HMAC-SHA256


        **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash}

        - timestamp: Unix timestamp in milliseconds

        - METHOD: HTTP method in UPPERCASE (GET, POST, etc.)

        - path: Request path (e.g., /v1/transactions)

        - bodyHash: SHA256 hex digest of request body (empty string if no body)


        **Timestamp Tolerance:** ±5 minutes (300 seconds)


        **Example:**

        For POST /v1/transactions with body {"amount":100} and timestamp
        1234567890000:

        Payload: 1234567890000.POST./v1/transactions.{sha256(body)}

        Signature: sha256=abc123...
    integratorKey:
      type: apiKey
      in: header
      name: X-Integrator-Key
      description: 'Integrator API key (format: int_...) used with HMAC authentication'
    timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: >-
        Unix timestamp in milliseconds for replay attack prevention. Must be
        within 5 minutes of server time.

````