Events
Subscription Address Updated
address associated with subscription is updated suggested source website front end properties name type description required actionable date string next date when this subscription will be actionable (renewed, expired, etc ) no address object shipping address for the subscription no brand string brand associated with the subscription no currency string currency code of the transaction (for example, "usd") pattern ^\[a z]{3}$ no email string email address associated with the subscription no end date string subscription will stop auto renewing after this date no interval length integer interval number at which the subscription renews no interval units string interval unit at which the subscription renews (for example, "month") no products object\[] products in the subscription no state string the state of the subscription (for example, "active") no subscription id string id of the subscription no example { "actionable date" "2024 04 01", "address" { "address1" "123 elm street", "address2" "suite 456", "city" "springfield", "company" "acme corp", "country" "usa", "name" "john doe", "phone" "555 1234", "state" "il", "zipcode" "62704" }, "brand" "green thumb nurseries", "currency" "usd", "email" "subscriber\@example com", "end date" "2025 04 01", "interval length" 1, "interval units" "month", "products" \[ { "affiliation" "my plant store", "brand" "green thumb nurseries", "bundle" false, "category" "outdoor plants", "coupon" "spring", "description" "a vibrant, easy to care for garden plant perfect for adding a splash of color to any outdoor space ", "image url" "https //example com/images/petunia jpg", "line item id" "234567891", "name" "petunia", "option values" \[ "purple", "red", "white" ], "parts" \[ { "name" "purple petunias", "options text" "purple" }, { "name" "pink petunias", "options text" "pink" } ], "position" 3, "price" 7 99, "product id" "123456789", "quantity" 2, "sku" "petunia 001", "slug" "petunia", "url" "https //example com/plants/petunia", "variant" "purple" } ], "state" "active", "subscription id" "sub 123456789" } address object shipping address for the subscription properties name type description required address1 string street address (line 1) address2 string street address (line 2) city string city company string company country string country name string name phone string phone number state string state zipcode string zipcode example { "address1" "123 elm street", "address2" "suite 456", "city" "springfield", "company" "acme corp", "country" "usa", "name" "john doe", "phone" "555 1234", "state" "il", "zipcode" "62704" } products\[] array products in the subscription the product item properties name type description required affiliation string product affiliation to designate a supplying company or brick and mortar store location (for example, "google store") no brand string brand associated with the product no bundle boolean product belongs to a bundle no category string product category no coupon string coupon code associated with a product (for example, "may deals 3") no description string short description of the product no image url string image url of the product no name string name of the product no option values string\[] option values of the product variant no position integer position in the product list (for example, 3) no price number price ($) of the product no product id string database id of the product no quantity integer quantity of the product no sku string sku of the product variant no slug string slug of the product, often used in urls (for example, "product red") no url string url of the product page no variant string name of the product variant no line item id string database id of the line item no parts object\[] if the product is an assortment, the assortment parts no example \[ { "affiliation" "my plant store", "brand" "green thumb nurseries", "bundle" false, "category" "outdoor plants", "description" "a vibrant, easy to care for garden plant perfect for adding a splash of color to any outdoor space ", "image url" "https //example com/images/petunia jpg", "name" "petunia", "option values" \[ "purple", "red", "white" ], "position" 3, "price" 7 99, "product id" "123456789", "sku" "petunia 001", "slug" "petunia", "url" "https //example com/plants/petunia", "variant" "purple", "coupon" "spring", "line item id" "234567891", "quantity" 2 } ] products\[] option values\[] array option values of the product variant option value (for example, "red") item type string example \[ "purple" ] products\[] parts\[] array if the product is an assortment, the assortment parts part item properties name type description required name string assortment part name options text string assortment part options text