Update order note for subscription

Updates the order note that will be added to all future orders generated by this subscription. Order notes help merchants track special instructions, customer preferences, or internal information about the subscription.

Full behavior, validation rules, and side effects

Key Features:

• Note is automatically added to all future recurring orders
• Visible in both merchant portal and customer portal
• Appears in Shopify order details for easy reference
• Changes apply to future orders only (existing orders unchanged) Common Use Cases:
• Customer preferences: “No nuts - severe allergy”
• Delivery instructions: “Leave package at side door”
• Gift messages: “Happy Birthday from Mom!”
• Internal notes: “VIP customer - priority handling”
• Processing instructions: “Include sample with each order”

Important Notes:

• Empty string clears the existing note
• No character limit imposed by API (check Shopify limits)
• HTML is not rendered - stored as plain text
• Updates are logged in activity history
• Note persists until explicitly changed

Order Generation: When Appstle creates recurring orders:

1. Retrieves current order note from subscription
2. Adds note to new Shopify order
3. Note appears in order details immediately
4. Merchants can still edit individual order notes

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-contracts-update-order-note/{contractId}

Update order note for subscription

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts-update-order-note/{contractId} \
  --header 'X-API-Key: <x-api-key>'

200

Example

true

Headers

X-API-Key · string · required

API Key for authentication

Path Parameters

contractId · integer<int64> · required

Subscription contract ID to update

Required range: x >= 1

Query Parameters

api_key · string

API Key (Deprecated - Use X-API-Key header instead)

orderNote · string · required

Note text to be added to all future orders. Can include special instructions, preferences, or internal notes. Pass empty string to clear existing note. HTML tags are not rendered - stored as plain text.

Response

200

application/json

Order note successfully updated

The response is of type boolean.