Update custom note attributes on subscription contract

Updates custom note attributes (key-value pairs) on a subscription contract. These attributes are stored on the Shopify subscription contract and propagated to recurring orders.

Full behavior, validation rules, and side effects

Modes:

• overwriteExistingAttributes=true (default): Replaces all existing note attributes with the provided list
• overwriteExistingAttributes=false: Merges provided attributes with existing ones (updates matching keys, adds new ones)

Use Cases:

• Clear tracking pixel IDs from recurring orders
• Update order-level metadata
• Store custom order instructions

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

PUT /api/external/v2/subscription-contracts-update-custom-note-attributes

Update custom note attributes on subscription contract

cURL

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-custom-note-attributes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "subscriptionContractId": 123456789,
  "customAttributesList": [
    {
      "key": "gift_message",
      "value": "Happy Birthday! Enjoy your subscription!"
    }
  ]
}
'

Headers

X-API-Key · string · required

API Key

Query Parameters

api_key · string

API Key (Deprecated)

overwriteExistingAttributes · boolean · default: true

When true (default), replaces all existing attributes. When false, merges with existing attributes.

Body

application/json

Request to update custom attributes on a subscription contract

subscriptionContractId · integer<int64> · required

The ID of the subscription contract to update

Example:

123456789

customAttributesList · object[] · required

List of custom attributes to set on the subscription contract. Each attribute is a key-value pair that will be stored with the subscription.

Show child attributes

Response

200

Note attributes successfully updated