Skip to main content

CreateAddressRequest

Properties​

address1​

address1: string

The street associated with the Address. Minimum length is 1 character.

address2?​

address2?: string

Any additional information associated with the Address.

city​

city: string

The city associated with the address.

company?​

company?: string

The company associated with the address.

country_code​

country_code: string

2-letter country code.

customer_id?​

customer_id?: number

Unique numeric identifier for the customer associated with the address, if not provided will be auto-filled from Session

discounts?​

discounts?: Object[]

A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address.

first_name​

first_name: string

The customer’s first name associated with the address.

is_gift?​

is_gift?: boolean

Set to true when this address is being used for redeeming gifts.

last_name​

last_name: string

The customer’s last name associated with the address.

order_attributes?​

order_attributes?: Property[]

Replaces cart_attributes. Extra information that is added to the order.

order_note?​

order_note?: string

Notes to be added to all orders associated with the address.

payment_method_id?​

payment_method_id?: number

Payment method id for the Payment_method to be associated to this address.

phone​

phone: string

The phone number associated with the address. Must be included in the request schema but can be an empty string.

presentment_currency?​

presentment_currency?: string

The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null.

province​

province: string

The state or province associated with the address.

shipping_lines_override?​

shipping_lines_override?: Object[]

Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated

zip​

zip: string

The zip or postal code associated with the address.

Generated using typedoc-plugin-markdown and TypeDoc