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": "[email protected]",
    "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
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