Updates the order note/instructions for a specific upcoming billing attempt. These notes are stored with the billing attempt and will appear on the Shopify order when it’s created. Order notes are visible to merchants in Shopify admin and can be printed on packing slips.
How It Works:
Important Timing Considerations:
QUEUED or SCHEDULEDSUCCESS or FAILED)Character Limits & Validation:
\n charactersCommon Use Cases:
Order Note vs Contract Note:
/subscription-contracts-update-order-note): Applies to ALL future ordersExample Workflows:
Scenario 1: One-time delivery instruction
1. Customer going on vacation next week
2. Call this endpoint to add "Deliver to neighbor at #123" for next billing attempt
3. Following orders resume normal delivery (no note)
Scenario 2: Clearing unwanted notes
1. Previous note says "Call before delivery"
2. Customer requests removal
3. Call this endpoint with orderNote="" (empty string)
4. Note cleared from next order
Scenario 3: Gift message for specific order
1. Customer's subscription ships to recipient monthly
2. Special occasion (birthday) on next delivery
3. Add gift message to next billing attempt only
4. Regular shipments continue without message
Integration Tips:
/subscription-billing-attempts endpoint firststatus field to ensure billing attempt can be modifiedError Handling:
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
curl --request PUT \
--url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts-update-order-note/{id}trueDocumentation Index
Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
Use this file to discover all available pages before exploring further.
Billing attempt ID
API Key (Deprecated - Use Header X-API-Key instead)
Order note/instructions text
Order note updated successfully. Returns true if update succeeded.
The response is of type boolean.
curl --request PUT \
--url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts-update-order-note/{id}true