Addresses

Saved shipping and billing addresses of the signed-in customer.

Every method here needs a signed-in customer. Sign one in with the authentication methods first.

subbly.addresses.list()

Gets every saved address of the signed-in customer.

ReturnsPromise<CustomerAddress[]>

The saved addresses. The array is empty when the customer has none.


List the addresses
const addresses = await subbly.addresses.list()

subbly.addresses.store(payload)

Creates a new saved address for the signed-in customer. Pass the new id to subbly.cart.update as shippingAddressId or billingAddressId.

Method parameters

payloadRequiredAddressStorePayload

The address to save.

ReturnsPromise<CustomerAddress>

The saved address.


Add an address
const address = await subbly.addresses.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+442071234567',
  addressOne: '12 Marylebone Road',
  addressTwo: null,
  city: 'London',
  zip: 'NW1 5JD',
  countryId: 826,
})

subbly.addresses.delete(addressId)

Deletes a saved address. The call fails when the address is still attached to a subscription.

Method parameters

addressIdRequirednumber

ID of the address to delete.

ReturnsPromise<void>

Nothing. The response body is empty.


Delete an address
await subbly.addresses.delete(4821)

Last modified on September 15, 2026

Addresses

Saved shipping and billing addresses of the signed-in customer.

Every method here needs a signed-in customer. Sign one in with the authentication methods first.

subbly.addresses.list()

Gets every saved address of the signed-in customer.

ReturnsPromise<CustomerAddress[]>

The saved addresses. The array is empty when the customer has none.


List the addresses
const addresses = await subbly.addresses.list()

subbly.addresses.store(payload)

Creates a new saved address for the signed-in customer. Pass the new id to subbly.cart.update as shippingAddressId or billingAddressId.

Method parameters

payloadRequiredAddressStorePayload

The address to save.

firstNameRequiredstring

Given name of the recipient.

lastNameRequiredstring

Family name of the recipient.

phoneoptionalstring

Phone number in international form. The shop needs it unless settings.phoneNumberOptional is on.

companyNameoptionalstring | null

Company name. Collect it only when the shop sets settings.collectCompanyName.

addressOneRequiredstring

First address line.

addressTwoRequiredstring | null

Second address line. Send null when there is none.

cityRequiredstring

City.

zipRequiredstring

Postal or ZIP code.

regionoptionalstring

Region name. Use it for countries with no region list.

regionIdoptionalnumber

ID of the region, from regions[].id of the country.

countryIdRequirednumber

ID of the country, from subbly.countries.list().

ReturnsPromise<CustomerAddress>

The saved address.


Add an address
const address = await subbly.addresses.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+442071234567',
  addressOne: '12 Marylebone Road',
  addressTwo: null,
  city: 'London',
  zip: 'NW1 5JD',
  countryId: 826,
})

subbly.addresses.delete(addressId)

Deletes a saved address. The call fails when the address is still attached to a subscription.

Method parameters

addressIdRequirednumber

ID of the address to delete.

ReturnsPromise<void>

Nothing. The response body is empty.


Delete an address
await subbly.addresses.delete(4821)

Last modified on September 15, 2026