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

# Create a credit note

> Reduces the creditable balance, posts a company credit for paid invoices, and emails the customer.



## OpenAPI

````yaml /openapi.yaml post /invoices/{id}/credit-notes
openapi: 3.0.3
info:
  title: ArcenPay API
  description: >
    The ArcenPay REST API powers subscription billing, entitlements, usage
    metering,

    payment links, checkout sessions, and autonomous agent payments across EVM
    (BOT Chain,

    Base, Arc, Sepolia), Stellar, and Solana.


    Every endpoint that accepts an API key supports the `Authorization: Bearer
    <key>` header.

    Key prefixes: `sk_…` (secret), `rk_…` (restricted), `pk_…` (publishable,
    read-only),

    `sk_…`/`rk_…`. Company-scoped customer endpoints accept an embed access
    token

    (`arc_tok_…` or a signed JWT from `identify()`). See the Authentication page
    for the

    full endpoint auth matrix.


    Manage catalog, environments, invoices, webhooks, feature flags, and agent
    configuration

    from the *dashboard* — those are not part of the developer-facing API
    reference.
  version: 1.0.0
servers:
  - url: https://api.arcenpay.com/api/v1
    description: Production
  - url: http://localhost:3300/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Credentials
    description: >-
      API keys, secret/publishable/restricted credentials, and short-lived
      tokens.
  - name: Companies
    description: Customer organizations, identity synchronization, and feature overrides.
  - name: Users
    description: Customer end-users associated with company organizations.
  - name: Events
    description: Ingest customer usage events and identification signals.
  - name: Access control
    description: >-
      Real-time entitlement checks, feature flags, and metered credit
      consumption.
  - name: Subscriptions
    description: >-
      On-chain subscription activation, self-serve plan switching, proration,
      and cancellation.
  - name: Checkout sessions
    description: Hosted checkout session lifecycle and status lookup.
  - name: Payment links
    description: Crypto payment links and dynamic payment URLs.
  - name: Autonomous agents
    description: >-
      Agent permissions, budget checking, on-chain funding, and auto-topup
      dispatch.
  - name: Mandates
    description: Recurring billing authorizations and mandate lifecycle.
  - name: Coupons
    description: Discount code validation and proration quoting.
  - name: zkTLS proofs
    description: Zero-knowledge TLS proofs verification via Reclaim Protocol.
  - name: Public
    description: Unauthenticated payment link specifications and checkout sessions.
  - name: Escrow
    description: >-
      Autonomous commit-reveal escrow reservations, release settlement, and
      dispute handling.
  - name: Features
    description: Feature catalog definitions, feature types, and linked plan entitlements.
paths:
  /invoices/{id}/credit-notes:
    post:
      tags:
        - Invoices
      summary: Create a credit note
      description: >-
        Reduces the creditable balance, posts a company credit for paid
        invoices, and emails the customer.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - reason
                - amount
              properties:
                reason:
                  type: string
                  maxLength: 500
                amount:
                  type: number
                  description: Positive amount, up to the remaining creditable balance.
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '201':
          description: The created credit note.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creditNote:
                    type: object
                    additionalProperties: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          description: Credit amount exceeds the remaining creditable balance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  remaining:
                    type: number
components:
  responses:
    BadRequest:
      description: Malformed request body or missing parameters.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              details:
                type: object
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              code:
                type: string
    Forbidden:
      description: Authenticated but not allowed (wrong key type or missing permission).
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              code:
                type: string
    NotFound:
      description: The requested resource does not exist.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
    Conflict:
      description: >-
        The request conflicts with current state (duplicate wallet, existing
        key, replay, etc.).
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              code:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_… / rk_… / pk_…

````

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