Updating the subscription's shipping address

Learn how to change the subscription's shipping address.

Managing the shipping address for a subscription is a straightforward process, allowing you to ensure your products always reach the right destination. Whether you need to update the address due to a customer's move or correct a previous error, our API makes it easy to modify the shipping details. Follow the intructions below to update the shipping address of any subscription with a simple API call.

Managing shipping addresses accurately is crucial for several reasons:

  • Customer satisfaction: Ensuring that products are delivered to the right address on time increases customer satisfaction and loyalty.

  • Reduced costs: Correct addresses help avoid extra shipping costs associated with returns and reshipments.

  • Efficiency: Streamlining the shipping process with accurate addresses improves operational efficiency and turnover time.

  • Reputation: Consistently accurate deliveries bolster a company's reputation for reliability and efficiency.

  • Compliance: Accurate shipping information is also a legal or regulatory requirement in certain industries and regions.

By maintaining up-to-date and precise shipping addresses, companies can streamline their logistics, reduce operational costs, and provide better customer service.

To manage a subscription's shipping address, use the POST /v1/subscriptions/{subscriptionId}/ship-to-address request. Replace {subscriptionId} with the actual subscription identifier, {Your_Access_Token} with your authorization key, send a JSON payload with the new address details.

curl --location --request POST 'https://{host}/v1/subscriptions/{subscriptionId}/ship-to-address' \
--header 'Authorization: Basic {Your_Access_Token}' \
...
--data-raw '{
    "firstName": "Jane", 
    "lastName": "Doe", 
    "companyName": "Acme Company", 
    "line1": "1234 Fake Street",
    "line2": "Apt. 2", 
    "line3": null, 
    "city": "Minnetonka",
    "countrySubdivision": "MN", 
    "postalCode": "55343", 
    "country": "US", 
    "phoneNumber": "555-253-1234", 
    "countyName" : null, 
    "emailAddress": "jdoe@acme.com" 
}'

After successfully updating the address, you will receive a 202 Accepted response. The new plan will go into effect immediately.

Last updated