Membership Contracts
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.
Modes:
overwriteExistingAttributes=true(default): Replaces all existing note attributes with the provided listoverwriteExistingAttributes=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
Update custom note attributes on subscription contract
Headers
API Key
Query Parameters
API Key (Deprecated)
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
Response
Note attributes successfully updated