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

# List credit notes

> The billing account's credit notes, newest first. Needs `billing.view`.



## OpenAPI

````yaml /api-reference/console/openapi.json get /credit-notes
openapi: 3.1.2
info:
  title: PerfGrid API
  version: 1.0.0
  description: >-
    The PerfGrid customer API. A member creates a token for one billing account
    under *API tokens* in the panel; it can do what both the token's permissions
    and the member's own permissions allow, the same as the panel.


    Send it as `Authorization: Bearer pgapi_...`. Each token may make 120
    requests a minute, of which 30 change something; a `429` response says when
    to try again (`Retry-After`). Ids are the ULIDs the API returns; amounts are
    decimal strings next to their currency; lists are newest first and paged
    with `cursor` (`meta.next_cursor`). Messages are in English, or Danish with
    `Accept-Language: da`.


    The same tokens work with the MCP server at `/mcp` for AI assistants.
servers:
  - url: https://console.perfgrid.com/api/v1
security:
  - http: []
tags:
  - name: Account
  - name: Invoices
  - name: Services
  - name: Domains
  - name: Support
paths:
  /credit-notes:
    get:
      tags:
        - Invoices
      summary: List credit notes
      description: The billing account's credit notes, newest first. Needs `billing.view`.
      operationId: v1.credit-notes.index
      responses:
        '200':
          description: Paginated set of `CreditNoteResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CreditNoteResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - first
                      - last
                      - prev
                      - next
                  meta:
                    type: object
                    properties:
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      next_cursor:
                        type:
                          - string
                          - 'null'
                        description: The "cursor" that points to the next set of items.
                      prev_cursor:
                        type:
                          - string
                          - 'null'
                        description: The "cursor" that points to the previous set of items.
                    required:
                      - path
                      - per_page
                      - next_cursor
                      - prev_cursor
                required:
                  - data
                  - links
                  - meta
        '403':
          $ref: '#/components/responses/AuthorizationException'
components:
  schemas:
    CreditNoteResource:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        invoice:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            number:
              type:
                - string
                - 'null'
          required:
            - id
            - number
        currency:
          type: string
        net:
          type:
            - string
            - 'null'
        credit:
          type:
            - string
            - 'null'
        subtotal:
          type:
            - string
            - 'null'
        tax:
          type:
            - string
            - 'null'
        total:
          type:
            - string
            - 'null'
        issue_date:
          type:
            - string
            - 'null'
        reason:
          type: string
        lines:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
              details:
                type:
                  - string
                  - 'null'
              period_start:
                type:
                  - string
                  - 'null'
              period_end:
                type:
                  - string
                  - 'null'
              net:
                type:
                  - string
                  - 'null'
              tax_scheme:
                type: string
                enum:
                  - domestic
                  - oss
                  - reverse_charge
                  - outside_eu
              tax_country:
                type:
                  - string
                  - 'null'
              tax_rate:
                type: string
            required:
              - description
              - details
              - period_start
              - period_end
              - net
              - tax_scheme
              - tax_country
              - tax_rate
        tax_totals:
          type: array
          items:
            type: object
            properties:
              tax_scheme:
                type: string
                enum:
                  - domestic
                  - oss
                  - reverse_charge
                  - outside_eu
              tax_country:
                type:
                  - string
                  - 'null'
              tax_rate:
                type: string
              taxable:
                type:
                  - string
                  - 'null'
              tax:
                type:
                  - string
                  - 'null'
            required:
              - tax_scheme
              - tax_country
              - tax_rate
              - taxable
              - tax
        links:
          type: object
          properties:
            pdf:
              type: string
          required:
            - pdf
      required:
        - id
        - number
        - invoice
        - currency
        - net
        - credit
        - subtotal
        - tax
        - total
        - issue_date
        - reason
        - links
      title: CreditNoteResource
  responses:
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    http:
      type: http
      description: >-
        An API token from *API tokens* in the console, sent as `Authorization:
        Bearer pgapi_...`. It works for one billing account, and its permissions
        decide which endpoints it may call.
      scheme: bearer

````

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