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

# Update order note for a billing attempt

> Updates the order note (customer note) for a billing attempt. This note will be included when the order is created in Shopify.

**Use Cases:**
- Add delivery instructions
- Include gift messages
- Add special handling notes
- Store customer preferences for this order

**Important Notes:**
- Only works on QUEUED billing attempts
- Note is included in the Shopify order when created
- Can be updated multiple times before order is processed

**Authentication:** Requires valid X-API-Key header



## OpenAPI

````yaml /subscription/admin-api-swagger.json put /api/external/v2/subscription-billing-attempts-update-order-note/{id}
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing subscriptions, payments, and
    related operations. These APIs allow you to programmatically manage
    subscription lifecycles, handle payments, configure products, and integrate
    subscription functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://subscription-admin.appstle.com
security: []
tags:
  - description: >-
      Core APIs for managing the complete subscription lifecycle including
      creation, updates, pausing, resuming, and cancellation of subscriptions.
    name: Subscription Management
  - description: >-
      APIs for managing subscription payment methods, processing payments,
      handling payment retries, and updating billing information.
    name: Subscription Payments
  - description: >-
      APIs for managing subscription contracts including delivery schedules,
      pricing, order notes, billing cycles, and shipping addresses.
    name: Subscription Contracts
  - description: >-
      APIs for managing products within subscriptions including adding,
      removing, updating quantities, and swapping products.
    name: Subscription Products
  - description: >-
      APIs for handling billing operations, payment processing, and financial
      transactions related to subscriptions.
    name: Billing & Payments
  - description: >-
      APIs for managing discounts and promotional codes applied to
      subscriptions.
    name: Subscription Discounts
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for managing subscription plans, pricing tiers, and plan
      configurations.
    name: Subscription Plans
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing the product catalog including product information,
      variants, and inventory.
    name: Product Catalog
  - description: >-
      APIs for managing operational settings, configurations, and administrative
      functions.
    name: Operations & Settings
  - description: >-
      APIs powering the customer-facing portal where subscribers can manage
      their own subscriptions.
    name: Customer Portal
  - description: APIs for managing customer information, profiles, and account details.
    name: Customers
  - description: >-
      APIs for retrieving aggregated subscription data, customer subscription
      history, and account-level subscription information.
    name: Subscription Data
  - description: >-
      APIs for managing delivery profiles, shipping rates, free shipping
      configuration, and delivery method options on subscriptions.
    name: Delivery & Shipping
  - description: >-
      APIs for managing storefront customization including custom CSS, theme
      settings, label translations, and merchant-defined widget configuration.
    name: Customization
  - description: >-
      APIs for configuring cancellation flows, retention offers, cancellation
      reason management, and win-back automation.
    name: Customer Retention
paths:
  /api/external/v2/subscription-billing-attempts-update-order-note/{id}:
    put:
      tags:
        - Billing & Payments
      summary: Update order note for a billing attempt
      description: >-
        Updates the order note (customer note) for a billing attempt. This note
        will be included when the order is created in Shopify.


        **Use Cases:**

        - Add delivery instructions

        - Include gift messages

        - Add special handling notes

        - Store customer preferences for this order


        **Important Notes:**

        - Only works on QUEUED billing attempts

        - Note is included in the Shopify order when created

        - Can be updated multiple times before order is processed


        **Authentication:** Requires valid X-API-Key header
      operationId: updateOrderNoteV2_1
      parameters:
        - description: Billing Attempt ID
          in: path
          name: id
          required: true
          schema:
            format: int64
            type: integer
        - description: API Key (Deprecated - Use Header X-API-Key instead)
          in: query
          name: api_key
          required: false
          schema:
            type: string
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
        - description: Updated Order Note
          in: query
          name: orderNote
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: boolean
          description: Order note successfully updated
        '400':
          content:
            '*/*':
              schema:
                type: boolean
          description: Invalid billing attempt ID
        '401':
          content:
            '*/*':
              schema:
                type: boolean
          description: Authentication required
        '403':
          content:
            '*/*':
              schema:
                type: boolean
          description: Insufficient permissions

````