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

# Get an invoice

> One fiscal invoice with its line items and the payments recorded against it.



## OpenAPI

````yaml /openapi-platform.json get /v1/platform/invoices/{id}
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/invoices/{id}:
    get:
      tags:
        - Invoices
      summary: Get an invoice
      description: >-
        One fiscal invoice with its line items and the payments recorded against
        it.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Invoice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformInvoiceDetail'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: Missing `invoices:read` scope
        '404':
          $ref: '#/components/responses/PlatformNotFound'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformInvoiceDetail:
      allOf:
        - $ref: '#/components/schemas/PlatformInvoice'
        - type: object
          properties:
            lineItems:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  quantity:
                    type: number
                  unitPrice:
                    type: number
                  totalAmount:
                    type: number
            payments:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  amount:
                    type: number
                  currency:
                    type: string
                  status:
                    type: string
                  paymentDate:
                    type: string
                    format: date-time
    PlatformInvoice:
      type: object
      description: A fiscal invoice. Pro-formas are never returned.
      properties:
        id:
          type: integer
        invoiceNumber:
          type: string
        invoiceDate:
          type: string
          format: date
          description: The calendar day the invoice belongs to, on the organization's clock
        dueDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - pending
            - paid
            - void
            - failed
            - settled
            - overdue
            - partially_paid
            - refunded
            - cancelled
        overdue:
          type: boolean
          description: Unpaid and past its due date
        currency:
          type: string
        subtotal:
          type: number
        taxAmount:
          type: number
        totalAmount:
          type: number
        sentAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        contact:
          type: object
          nullable: true
          properties:
            id:
              type: integer
            name:
              type: string
        billingEntity:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
    PlatformError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            A stable, machine-readable reason, when the error has one (e.g.
            `CONTACT_EXISTS`).
        details:
          type: object
          additionalProperties: true
          description: >-
            Structured values behind the error. A 409 naming an existing record
            carries its id here, e.g. `contactId`.
  responses:
    PlatformBadRequest:
      description: Invalid request (bad parameters, or a body that fails validation)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformNotFound:
      description: The requested resource does not exist in this organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````

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