Address

Overview

Addresses store a customer’s shipping and billing information, used for fulfillment and tax. These endpoints add and update the authenticated customer’s addresses. Both require a bearer token.


How It Works

  1. Create - Add a shipping or billing address for the customer.
  2. Use - Associate the address with subscriptions and orders for fulfillment.
  3. Update - Correct or change details on an existing address.

Example: A customer adds a home shipping address at checkout, then later updates the postal code.


API Endpoints

MethodEndpointDescription
POST/api/v1/sdk/addressCreate address
PUT/api/v1/sdk/address/{address_id}Update address

Important Behaviors

  • Authentication: Both endpoints require a bearer token.
  • Response shape: Both return the shared customer resource (with data.addresses) plus a meta block (account_id, site_id, features).
  • Type is immutable on update: The address type cannot be changed once set.
  • Ownership: Updating an address the customer does not own returns 404.