Membership Contracts

Update shipping address for subscription contract

Changes the delivery shipping address for a subscription contract. This allows customers to update where their subscription orders are delivered.

Key Features:

Full Address Update: Change complete shipping address in one call
Address Validation: System validates address format and country codes
Immediate Effect: New address applies to the next delivery
Activity Logging: All address changes are logged for audit trail
International Support: Supports addresses in all countries

Required Address Fields:

firstName: Recipient’s first name
lastName: Recipient’s last name
address1: Street address line 1
city: City name
countryCode: ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
zip: Postal/ZIP code

Optional Address Fields:

address2: Apartment, suite, unit number
company: Company name (for business addresses)
phone: Contact phone number
provinceCode: State/province code (e.g., CA, NY, ON)

Common Use Cases:

Customer Moved: Update address after relocation
Temporary Address: Ship to vacation home or temporary location
Gift Recipient: Change recipient for gift subscriptions
Correct Typos: Fix address errors from initial signup
Business to Home: Switch between business and residential addresses
Seasonal Address: Update for snowbird/seasonal residents

Country and Province Codes:

countryCode: Use ISO 3166-1 alpha-2 codes
- Examples: US (United States), CA (Canada), GB (United Kingdom), AU (Australia)
provinceCode: Use ISO 3166-2 subdivision codes
- US Examples: CA (California), NY (New York), TX (Texas)
- Canada Examples: ON (Ontario), BC (British Columbia), QC (Quebec)

Address Validation:

Format Validation: System checks required fields are present
Country Validation: Verifies country code is valid
Province Validation: Checks province code matches country
Postal Code: Validates postal code format for country

Important Notes:

Shipping Rate Recalculation: New address may have different shipping costs
Delivery Method: System automatically selects appropriate delivery method
Next Order Only: Only affects future orders, not orders already placed
Address Book: Consider updating customer’s default address separately
PO Boxes: Some delivery methods may not support PO Box addresses

Shipping Cost Impact:

Changing address may change shipping costs for future deliveries
International addresses typically have higher shipping costs
Remote/rural areas may have additional delivery fees
Consider notifying customer of cost changes

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

PUT

api

external

subscription-contracts-update-shipping-address

Update shipping address for subscription contract

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "city": "San Francisco",
  "company": "Acme Corp",
  "countryCode": "US",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1-415-555-0123",
  "provinceCode": "CA",
  "zip": "94102"
}
'

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address"

payload = {
    "address1": "123 Main Street",
    "address2": "Apt 4B",
    "city": "San Francisco",
    "company": "Acme Corp",
    "countryCode": "US",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1-415-555-0123",
    "provinceCode": "CA",
    "zip": "94102"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    address1: '123 Main Street',
    address2: 'Apt 4B',
    city: 'San Francisco',
    company: 'Acme Corp',
    countryCode: 'US',
    firstName: 'John',
    lastName: 'Doe',
    phone: '+1-415-555-0123',
    provinceCode: 'CA',
    zip: '94102'
  })
};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    address1: '123 Main Street',
    address2: 'Apt 4B',
    city: 'San Francisco',
    company: 'Acme Corp',
    countryCode: 'US',
    firstName: 'John',
    lastName: 'Doe',
    phone: '+1-415-555-0123',
    provinceCode: 'CA',
    zip: '94102'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address1' => '123 Main Street',
    'address2' => 'Apt 4B',
    'city' => 'San Francisco',
    'company' => 'Acme Corp',
    'countryCode' => 'US',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'phone' => '+1-415-555-0123',
    'provinceCode' => 'CA',
    'zip' => '94102'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address"

	payload := strings.NewReader("{\n  \"address1\": \"123 Main Street\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"company\": \"Acme Corp\",\n  \"countryCode\": \"US\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"phone\": \"+1-415-555-0123\",\n  \"provinceCode\": \"CA\",\n  \"zip\": \"94102\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address1\": \"123 Main Street\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"company\": \"Acme Corp\",\n  \"countryCode\": \"US\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"phone\": \"+1-415-555-0123\",\n  \"provinceCode\": \"CA\",\n  \"zip\": \"94102\"\n}"

response = http.request(request)
puts response.read_body

{
  "billingAttempts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "completedAt": {},
        "createdAt": {},
        "get__typename": "<string>",
        "id": "<string>",
        "idempotencyKey": "<string>",
        "ready": true
      }
    ]
  },
  "billingPolicy": {
    "anchors": [
      {
        "cutoffDay": 123,
        "day": 123,
        "get__typename": "<string>",
        "month": 123,
        "type": "WEEKDAY"
      }
    ],
    "get__typename": "<string>",
    "interval": "DAY",
    "intervalCount": 123,
    "maxCycles": 123,
    "minCycles": 123
  },
  "createdAt": {},
  "customAttributes": [
    {
      "get__typename": "<string>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "customer": {
    "displayName": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "get__typename": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "customerPaymentMethod": {
    "get__typename": "<string>",
    "id": "<string>",
    "instrument": {
      "get__typename": "<string>"
    },
    "revokedAt": {},
    "revokedReason": "AUTHORIZE_NET_GATEWAY_NOT_ENABLED"
  },
  "deliveryMethod": {
    "additionalInformation": {
      "get__typename": "<string>",
      "instructions": "<string>"
    },
    "brandedPromise": {
      "get__typename": "<string>",
      "handle": "<string>",
      "name": "<string>"
    },
    "get__typename": "<string>",
    "id": "<string>",
    "maxDeliveryDateTime": {},
    "methodType": "SHIPPING",
    "minDeliveryDateTime": {},
    "serviceCode": "<string>"
  },
  "deliveryPolicy": {
    "anchors": [
      {
        "cutoffDay": 123,
        "day": 123,
        "get__typename": "<string>",
        "month": 123,
        "type": "WEEKDAY"
      }
    ],
    "get__typename": "<string>",
    "interval": "DAY",
    "intervalCount": 123
  },
  "deliveryPrice": {
    "amount": {},
    "currencyCode": "USD",
    "get__typename": "<string>"
  },
  "discounts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "createdAt": {},
        "deliveredAt": {},
        "displayStatus": "ATTEMPTED_DELIVERY",
        "estimatedDeliveryAt": {},
        "get__typename": "<string>",
        "id": "<string>",
        "inTransitAt": {},
        "name": "<string>",
        "requiresShipping": true,
        "service": {
          "get__typename": "<string>",
          "handle": "<string>",
          "serviceName": "<string>",
          "type": "GIFT_CARD"
        },
        "status": "PENDING",
        "trackingInfo": [
          {
            "company": "<string>",
            "get__typename": "<string>",
            "number": "<string>",
            "url": {}
          }
        ]
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "get__typename": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  },
  "get__typename": "<string>",
  "id": "<string>",
  "lastPaymentStatus": "SUCCEEDED",
  "lines": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>"
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "get__typename": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  },
  "nextBillingDate": {},
  "note": "<string>",
  "originOrder": {
    "fulfillmentOrders": {
      "get__typename": "<string>",
      "nodes": [
        {
          "get__typename": "<string>"
        }
      ],
      "pageInfo": {
        "endCursor": "<string>",
        "get__typename": "<string>",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "<string>"
      }
    },
    "get__typename": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "status": "ACTIVE",
  "updatedAt": {}
}

Headers

X-API-Key

string

Query Parameters

contractId

integer<int64>

required

Subscription contract ID

api_key

string

API Key (Deprecated - Use Header X-API-Key instead)

Body

application/json

New shipping address details

address1

string

Primary street address

Example:

"123 Main St"

address2

string

Secondary address line (apt, suite, etc.)

Example:

"Apt 4B"

city

string

City name

Example:

"New York"

company

string

Company name

Example:

"Acme Inc"

country

string

Country name

Example:

"United States"

countryCode

string

ISO country code

Example:

"US"

firstName

string

Recipient first name

Example:

"John"

lastName

string

Recipient last name

Example:

"Doe"

phone

string

Contact phone number

Example:

"+1-555-123-4567"

province

string

State or province name

Example:

"New York"

provinceCode

string

State/province code

Example:

"NY"

zip

string

Postal/ZIP code

Example:

"10001"

Response

Shipping address successfully updated

billingAttempts

object

Show child attributes

billingPolicy

object

Show child attributes

createdAt

object

customAttributes

object[]

Show child attributes

customer

object

Show child attributes

customerPaymentMethod

object

Show child attributes

deliveryMethod

object

Show child attributes

deliveryPolicy

object

Show child attributes

deliveryPrice

object

Show child attributes

discounts

object

Show child attributes

get__typename

string

lastPaymentStatus

enum<string>

Available options:

SUCCEEDED,

FAILED,

$UNKNOWN

lines

object

Show child attributes

nextBillingDate

object

note

string

originOrder

object

Show child attributes

status

enum<string>

Available options:

ACTIVE,

PAUSED,

CANCELLED,

EXPIRED,

FAILED,

$UNKNOWN

updatedAt

object

Update shipping address for subscription contract

curl --request PUT \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "city": "San Francisco",
  "company": "Acme Corp",
  "countryCode": "US",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1-415-555-0123",
  "provinceCode": "CA",
  "zip": "94102"
}
'

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address"

payload = {
    "address1": "123 Main Street",
    "address2": "Apt 4B",
    "city": "San Francisco",
    "company": "Acme Corp",
    "countryCode": "US",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1-415-555-0123",
    "provinceCode": "CA",
    "zip": "94102"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    address1: '123 Main Street',
    address2: 'Apt 4B',
    city: 'San Francisco',
    company: 'Acme Corp',
    countryCode: 'US',
    firstName: 'John',
    lastName: 'Doe',
    phone: '+1-415-555-0123',
    provinceCode: 'CA',
    zip: '94102'
  })
};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    address1: '123 Main Street',
    address2: 'Apt 4B',
    city: 'San Francisco',
    company: 'Acme Corp',
    countryCode: 'US',
    firstName: 'John',
    lastName: 'Doe',
    phone: '+1-415-555-0123',
    provinceCode: 'CA',
    zip: '94102'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address1' => '123 Main Street',
    'address2' => 'Apt 4B',
    'city' => 'San Francisco',
    'company' => 'Acme Corp',
    'countryCode' => 'US',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'phone' => '+1-415-555-0123',
    'provinceCode' => 'CA',
    'zip' => '94102'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address"

	payload := strings.NewReader("{\n  \"address1\": \"123 Main Street\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"company\": \"Acme Corp\",\n  \"countryCode\": \"US\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"phone\": \"+1-415-555-0123\",\n  \"provinceCode\": \"CA\",\n  \"zip\": \"94102\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-contracts-update-shipping-address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address1\": \"123 Main Street\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"company\": \"Acme Corp\",\n  \"countryCode\": \"US\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"phone\": \"+1-415-555-0123\",\n  \"provinceCode\": \"CA\",\n  \"zip\": \"94102\"\n}"

response = http.request(request)
puts response.read_body

{
  "billingAttempts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "completedAt": {},
        "createdAt": {},
        "get__typename": "<string>",
        "id": "<string>",
        "idempotencyKey": "<string>",
        "ready": true
      }
    ]
  },
  "billingPolicy": {
    "anchors": [
      {
        "cutoffDay": 123,
        "day": 123,
        "get__typename": "<string>",
        "month": 123,
        "type": "WEEKDAY"
      }
    ],
    "get__typename": "<string>",
    "interval": "DAY",
    "intervalCount": 123,
    "maxCycles": 123,
    "minCycles": 123
  },
  "createdAt": {},
  "customAttributes": [
    {
      "get__typename": "<string>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "customer": {
    "displayName": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "get__typename": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "customerPaymentMethod": {
    "get__typename": "<string>",
    "id": "<string>",
    "instrument": {
      "get__typename": "<string>"
    },
    "revokedAt": {},
    "revokedReason": "AUTHORIZE_NET_GATEWAY_NOT_ENABLED"
  },
  "deliveryMethod": {
    "additionalInformation": {
      "get__typename": "<string>",
      "instructions": "<string>"
    },
    "brandedPromise": {
      "get__typename": "<string>",
      "handle": "<string>",
      "name": "<string>"
    },
    "get__typename": "<string>",
    "id": "<string>",
    "maxDeliveryDateTime": {},
    "methodType": "SHIPPING",
    "minDeliveryDateTime": {},
    "serviceCode": "<string>"
  },
  "deliveryPolicy": {
    "anchors": [
      {
        "cutoffDay": 123,
        "day": 123,
        "get__typename": "<string>",
        "month": 123,
        "type": "WEEKDAY"
      }
    ],
    "get__typename": "<string>",
    "interval": "DAY",
    "intervalCount": 123
  },
  "deliveryPrice": {
    "amount": {},
    "currencyCode": "USD",
    "get__typename": "<string>"
  },
  "discounts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "createdAt": {},
        "deliveredAt": {},
        "displayStatus": "ATTEMPTED_DELIVERY",
        "estimatedDeliveryAt": {},
        "get__typename": "<string>",
        "id": "<string>",
        "inTransitAt": {},
        "name": "<string>",
        "requiresShipping": true,
        "service": {
          "get__typename": "<string>",
          "handle": "<string>",
          "serviceName": "<string>",
          "type": "GIFT_CARD"
        },
        "status": "PENDING",
        "trackingInfo": [
          {
            "company": "<string>",
            "get__typename": "<string>",
            "number": "<string>",
            "url": {}
          }
        ]
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "get__typename": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  },
  "get__typename": "<string>",
  "id": "<string>",
  "lastPaymentStatus": "SUCCEEDED",
  "lines": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>"
      }
    ],
    "pageInfo": {
      "endCursor": "<string>",
      "get__typename": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>"
    }
  },
  "nextBillingDate": {},
  "note": "<string>",
  "originOrder": {
    "fulfillmentOrders": {
      "get__typename": "<string>",
      "nodes": [
        {
          "get__typename": "<string>"
        }
      ],
      "pageInfo": {
        "endCursor": "<string>",
        "get__typename": "<string>",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "<string>"
      }
    },
    "get__typename": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "status": "ACTIVE",
  "updatedAt": {}
}

Get Started

Guides

Partner Integration

Webhooks

Admin API

Customer Portal API

Update shipping address for subscription contract

Headers

Query Parameters

Body

Response