UpdateAddressRequest
Extends
Omit
<Partial
<CreateAddressRequest
>,"presentment_currency"
|"customer_id"
|"discounts"
>
Properties
address1?
address1?:
string
The street associated with the Address. Minimum length is 1 character.
Inherited from
Omit.address1
address2?
address2?:
string
Any additional information associated with the Address.
Inherited from
Omit.address2
city?
city?:
string
The city associated with the address.
Inherited from
Omit.city
company?
company?:
string
The company associated with the address.
Inherited from
Omit.company
country_code?
country_code?:
string
2-letter country code.
Inherited from
Omit.country_code
discounts?
discounts?:
Object
[]
first_name?
first_name?:
string
The customer’s first name associated with the address.
Inherited from
Omit.first_name
is_gift?
is_gift?:
boolean
Set to true when this address is being used for redeeming gifts.
Inherited from
Omit.is_gift
last_name?
last_name?:
string
The customer’s last name associated with the address.
Inherited from
Omit.last_name
order_attributes?
order_attributes?:
Property
[]
Replaces cart_attributes. Extra information that is added to the order.
Inherited from
Omit.order_attributes
order_note?
order_note?:
string
Notes to be added to all orders associated with the address.
Inherited from
Omit.order_note
payment_method_id?
payment_method_id?:
number
Payment method id for the Payment_method to be associated to this address.
Inherited from
Omit.payment_method_id
phone?
phone?:
string
The phone number associated with the address. Must be included in the request schema but can be an empty string.
Inherited from
Omit.phone
province?
province?:
string
The state or province associated with the address.
Inherited from
Omit.province
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
Inherited from
Omit.shipping_lines_override
zip?
zip?:
string
The zip or postal code associated with the address.
Inherited from
Omit.zip
Generated using typedoc-plugin-markdown and TypeDoc