billing_addresses
Description
This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.
Sandbox Example
You can interact with this resource and run actions against the sandbox API via our HAL Brower.
Actions
- GET
- View a list of billing_addresses
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Example Representation
{ "_links": { "curies": [ { "name": "fx", "href": "https://api.foxycart.com/rels/{rel}", "templated": true } ], "self": { "href": "...", "title": "This Collection" }, "first": { "href": "...?offset=0", "title": "First Page of this Collection" }, "prev": { "href": "...?offset=0", "title": "Previous Page of this Collection" }, "next": { "href": "...?offset=0", "title": "Next Page of this Collection" }, "last": { "href": "...?offset=0", "title": "Last Page of this Collection" } }, "_embedded": { "fx:billing_addresses": [...] }, "total_items": "5", "returned_items": 5, "limit": 20, "offset": 0 }
<?xml version="1.0" encoding="UTF-8"?> <resource href="..."> <link rel="self" href="..." title="This Collection"/> <link rel="first" href="...?offset=0" title="First Page of this Collection"/> <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/> <link rel="next" href="...?offset=0" title="Next Page of this Collection"/> <link rel="last" href="...?offset=0" title="Last Page of this Collection"/> <resource href="..." rel="https://api.foxycart.com/rels/billing_address"> ... </resource> <total_items>5</total_items> <returned_items>5</returned_items> <limit>20</limit> <offset>0</offset> </resource>
{ "properties": { "total_items": "5", "returned_items": 5, "limit": 20, "offset": 0 }, "entities": [...], "links": [ { "rel": [ "self" ], "href": "..." }, { "rel": [ "first" ], "href": "...?offset=0" }, { "rel": [ "prev" ], "href": "...?offset=0" }, { "rel": [ "next" ], "href": "...?offset=0" }, { "rel": [ "last" ], "href": "...?offset=0" } ], "actions": [ ] }
Embedded Resource: billing_address
Description
The read only billing address used in a completed transaction.
Sandbox Example
You can interact with this resource and run actions against the sandbox API via our HAL Brower.
Actions
- GET
- View a billing_address
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
Property | Description | Type | Constraints |
---|---|---|---|
address_name | The name of this address. This is also the value used as the shipto entry for a multiship item. | String | Read only |
first_name | The given name associated with this address. | String | Read only |
last_name | The surname associated with this address. | String | Read only |
company | The company associated with this address. | String | Read only |
address1 | The first line of the street address. | String | Read only |
address2 | The second line of the street address. | String | Read only |
city | The city of this address. | String | Read only |
region | 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. | String | Read only |
postal_code | The postal code of this address. | String | Read only |
country | The country code of this address. | String | Read only |
phone | The phone of this address. | String | Read only |
is_default_billing | Specifies if this address is the default billing address for the customer. | Boolean | Read only |
is_default_shipping | Specifies if this address is the default shipping address for the customer. | Boolean | Read only |
date_created | The date this resource was created. | Date | Read only |
date_modified | The date this resource was last modified. | Date | Read only |
Example Representation
{ "_links": { "curies": [ { "name": "fx", "href": "https://api.foxycart.com/rels/{rel}", "templated": true } ], "self": { "href": "https://api.foxycart.com/transactions/40/billing_address", "title": "This Billing Address" }, "fx:store": { "href": "https://api.foxycart.com/stores/8", "title": "This Store" }, "fx:transaction": { "href": "https://api.foxycart.com/transactions/40", "title": "This Transaction" }, "fx:billing_addresses": { "href": "https://api.foxycart.com/transactions/40/billing_addresses", "title": "Billing Addresses for this Transaction" }, "fx:customer": { "href": "https://api.foxycart.com/customers/46946", "title": "This Customer" }, "fx:customer_address": { "href": "https://api.foxycart.com/customers/46946/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" }
<?xml version="1.0" encoding="UTF-8"?> <resource href="https://api.foxycart.com/transactions/40/billing_address" rel="https://api.foxycart.com/rels/billing_address"> <link rel="self" href="https://api.foxycart.com/transactions/40/billing_address" title="This Billing Address"/> <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/8" title="This Store"/> <link rel="https://api.foxycart.com/rels/transaction" href="https://api.foxycart.com/transactions/40" title="This Transaction"/> <link rel="https://api.foxycart.com/rels/billing_addresses" href="https://api.foxycart.com/transactions/40/billing_addresses" title="Billing Addresses for this Transaction"/> <link rel="https://api.foxycart.com/rels/customer" href="https://api.foxycart.com/customers/46946" title="This Customer"/> <link rel="https://api.foxycart.com/rels/customer_address" href="https://api.foxycart.com/customers/46946/default_billing_address" title="This Customer Address"/> <address_name>awesome</address_name> <first_name>firstname</first_name> <last_name>lastname</last_name> <company>My company</company> <address1>12345 Any Street</address1> <address2></address2> <city>Any City</city> <region>TN</region> <postal_code>37211</postal_code> <country>US</country> <phone></phone> <is_default_billing>false</is_default_billing> <is_default_shipping>false</is_default_shipping> <date_created>2013-08-16T14:53:46-0700</date_created> <date_modified>2013-08-16T14:53:46-0700</date_modified> </resource>
{ "class": [ "billing_address" ], "properties": { "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" }, "links": [ { "rel": [ "self" ], "href": "https://api.foxycart.com/transactions/40/billing_address" }, { "rel": [ "https://api.foxycart.com/rels/store" ], "href": "https://api.foxycart.com/stores/8" }, { "rel": [ "https://api.foxycart.com/rels/customer" ], "href": "https://api.foxycart.com/customers/8" }, { "rel": [ "https://api.foxycart.com/rels/transaction" ], "href": "https://api.foxycart.com/transactions/40" }, { "rel": [ "https://api.foxycart.com/rels/billing_addresses" ], "href": "https://api.foxycart.com/transactions/40/billing_addresses" }, { "rel": [ "https://api.foxycart.com/rels/customer" ], "href": "https://api.foxycart.com/customers/46946" }, { "rel": [ "https://api.foxycart.com/rels/customer_address" ], "href": "https://api.foxycart.com/customers/46946/default_billing_address" } ] }
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.