---
displayed_sidebar: servicesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AddressPayload

Address fields used when creating/updating an address.

## constructor

`**new AddressPayload**()`

Address fields used when creating/updating an address.

___

## Properties

<ParameterTypes parameters={[
  {
    "name": "address_1",
    "type": "`string`",
    "description": "Address line 1",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "address_2",
    "type": "`string`",
    "description": "Address line 2",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "city",
    "type": "`string`",
    "description": "City",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "company",
    "type": "`string`",
    "description": "Company",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "country_code",
    "type": "`string`",
    "description": "The 2 character ISO code of the country in lower case",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "first_name",
    "type": "`string`",
    "description": "First name",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "last_name",
    "type": "`string`",
    "description": "Last name",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "An optional key-value map with additional details",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "phone",
    "type": "`string`",
    "description": "Phone Number",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "postal_code",
    "type": "`string`",
    "description": "Postal Code",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "province",
    "type": "`string`",
    "description": "Province",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />
