billing_address

Collection: billing_addresses

The read only billing address used in a completed transaction.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

GET View a billing address
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (15)

address_name String · Read-only

The name of this address. This is also the value used as the shipto entry for a multiship item.

first_name String · Read-only

The given name associated with this address.

last_name String · Read-only

The surname associated with this address.

company String · Read-only

The company associated with this address.

address1 String · Read-only

The first line of the street address.

address2 String · Read-only

The second line of the street address.

city String · Read-only

The city of this address.

region String · Read-only

The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.

postal_code String · Read-only

The postal code of this address.

country String · Read-only

The country code of this address.

phone String · Read-only

The phone of this address.

is_default_billing Boolean · Read-only

Specifies if this address is the default billing address for the customer.

is_default_shipping Boolean · Read-only

Specifies if this address is the default shipping address for the customer.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (6)

self This Billing Address
fx:store GET PATCH PUT DELETE This Store
fx:transaction GET PATCH PUT POST This Transaction
fx:billing_addresses GET Billing Addresses for this Transaction
fx:customer GET PATCH PUT DELETE This Customer
fx:customer_address GET PATCH PUT DELETE This Customer Address
https://api.foxycart.com/transactions/{id}/billing_address

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/transactions/123/billing_address",
      "title": "This Billing Address"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transaction": {
      "href": "https://api.foxycart.com/transactions/123",
      "title": "This Transaction"
    },
    "fx:billing_addresses": {
      "href": "https://api.foxycart.com/transactions/123/billing_addresses",
      "title": "Billing Addresses for this Transaction"
    },
    "fx:customer": {
      "href": "https://api.foxycart.com/customers/789",
      "title": "This Customer"
    },
    "fx:customer_address": {
      "href": "https://api.foxycart.com/customers/789/default_billing_address",
      "title": "This Customer Address"
    }
  },
  "address_name": "awesome",
  "first_name": "firstname",
  "last_name": "lastname",
  "company": "My company",
  "address1": "12345 Any Street",
  "address2": "",
  "city": "Any City",
  "region": "TN",
  "postal_code": "37211",
  "country": "US",
  "phone": "",
  "is_default_billing": false,
  "is_default_shipping": false,
  "date_created": "2013-08-16T14:53:46-0700",
  "date_modified": "2013-08-16T14:53:46-0700"
}