braintree · Schema

Address

A billing or shipping address associated with a transaction or customer.

Properties

Name Type Description
first_name string First name of the address holder.
last_name string Last name of the address holder.
company string Company or organization name at this address.
street_address string Primary street address line.
extended_address string Secondary address line such as apartment or suite number.
locality string City or locality of the address.
region string State, province, or region code of the address.
postal_code string Postal or ZIP code of the address.
country_code_alpha2 string Two-letter ISO 3166-1 alpha-2 country code.
View JSON Schema on GitHub

JSON Schema

braintree-address-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "type": "object",
  "description": "A billing or shipping address associated with a transaction or customer.",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name of the address holder.",
      "maxLength": 255
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the address holder.",
      "maxLength": 255
    },
    "company": {
      "type": "string",
      "description": "Company or organization name at this address.",
      "maxLength": 255
    },
    "street_address": {
      "type": "string",
      "description": "Primary street address line.",
      "maxLength": 255
    },
    "extended_address": {
      "type": "string",
      "description": "Secondary address line such as apartment or suite number.",
      "maxLength": 255
    },
    "locality": {
      "type": "string",
      "description": "City or locality of the address.",
      "maxLength": 255
    },
    "region": {
      "type": "string",
      "description": "State, province, or region code of the address.",
      "maxLength": 255
    },
    "postal_code": {
      "type": "string",
      "description": "Postal or ZIP code of the address.",
      "maxLength": 9
    },
    "country_code_alpha2": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha-2 country code.",
      "pattern": "^[A-Z]{2}$"
    }
  }
}