Skip to main content

Interface: Address

Properties​

address1​

address1: string

The street associated with the Address.

address2?​

optional address2?: string | null

Any additional information associated with the Address.

city​

city: string

The city associated with the address.

company​

company: string | null

The company associated with the address.

country_code​

country_code: string

2-letter country code.

created_at​

created_at: string

The date and time when the address was created.

customer_id​

customer_id: number

Unique numeric identifier for the customer associated with the address.

discounts​

discounts: object[]

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

id​

id: number

first_name​

first_name: string

The customer’s first name associated with the address.

id​

id: number

Unique numeric identifier for the Address.

include?​

optional include?: object

Additional information as requested

customer?​

optional customer?: Customer

payment_methods?​

optional payment_methods?: PaymentMethod[]

subscriptions?​

optional subscriptions?: Subscription[]

is_gift​

is_gift: boolean

This address is set as a gift address and should only be used for gift redemptions.

last_name​

last_name: string

The customer’s last name associated with the address.

note_attributes?​

optional note_attributes?: ({ name: "rc_giftee_email"; value: string; } | { name: string; value: string; })[]

order_attributes​

order_attributes: Property[]

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

order_note​

order_note: string | null

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

payment_method_id​

payment_method_id: number

Unique numeric identifier for the Payment Method associated to the Address.

phone​

phone: string | null

The phone number associated with the address.

presentment_currency​

presentment_currency: string | null

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 | null

The state or province associated with the address.

shipping_lines_conserved​

shipping_lines_conserved: object[] | null

The shipping lines that were conserved from the original order when the address was created.

shipping_lines_override​

shipping_lines_override: object[] | null

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

updated_at​

updated_at: string

The date and time when the address was last updated.

zip?​

optional zip?: string | null

The zip or postal code associated with the address.