Updates or replaces custom key-value attributes on a subscription contract. These attributes are stored with the subscription and can be used to track custom data, preferences, or metadata that’s important for your business processes.
Custom Attributes Overview: Custom attributes are key-value pairs that allow you to store additional information on subscriptions. They are:
Update Modes:
Common Use Cases:
Important Notes:
Authentication: Requires valid X-API-Key header
curl --request POST \
--url https://www.myshop.com/apps/subscriptions/cp/api/update-custom-note-attributes \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionContractId": 123456789,
"customAttributesList": [
{
"key": "gift_message",
"value": "Happy Birthday! Enjoy your subscription!"
}
]
}
'{
"message": "Attributes updated successfully"
}Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Request to update custom attributes on a subscription contract
The ID of the subscription contract to update
123456789
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
Attributes successfully updated
curl --request POST \
--url https://www.myshop.com/apps/subscriptions/cp/api/update-custom-note-attributes \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionContractId": 123456789,
"customAttributesList": [
{
"key": "gift_message",
"value": "Happy Birthday! Enjoy your subscription!"
}
]
}
'{
"message": "Attributes updated successfully"
}