SubscriptionMailingAddress object

Represents a Mailing Address on a Subscription.

Required access

Requires either all_subscription_contracts or own_subscription_contracts scope.

On this page

Fields

  • address1 ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The first line of the address. Typically the street address or PO Box number.
  • address2 ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The second line of the address. Typically the number of the apartment, suite, or unit.
  • city ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the city, district, village, or town.
  • company ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the customer’s company or organization.
  • country ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the country.
  • countryCode ([CountryCode](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/countrycode))
    The two-letter code for the country of the address.
    For example, US.
  • firstName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The first name of the customer.
  • lastName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The last name of the customer.
  • name ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The full name of the customer, based on firstName and lastName.
  • phone ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
  • province ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The region of the address, such as the province, state, or district.
  • provinceCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The two-letter code for the region.
    For example, ON.
  • zip ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The zip or postal code of the address.

Types that return SubscriptionMailingAddress

  • [SubscriptionDeliveryMethodShipping.address](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondeliverymethodshipping#address-2021-01)