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.

Full behavior, validation rules, and side effects

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

PUT /api/external/v2/subscription-billing-attempts-update-order-note/{id}

Update order note for a billing attempt

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-billing-attempts-update-order-note/{id}

200

true

Headers

X-API-Key · string

Path Parameters

id · integer<int64> · required

Billing Attempt ID

Query Parameters

api_key · string

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

orderNote · string · required

Updated Order Note

Response

200

application/json

Order note successfully updated

The response is of type boolean.