billing_info

The billing information of the invoice recipient. Includes name, address, email, phone, and language.

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

email_addressstring<restrictive_email_address>Optional

The internationalized email address with more restrictive rules. This version restricts the local-part to a dot-atom as defined in https://www.ietf.org/rfc/rfc5322.txt. It does not allow for a quoted-string or an obs-local-part.

Allows alphanumeric and RFC-allowed special characters, !#$%&'*+-/=?^_`{|}~
Ensures that the local part does not start with dot (.), have consecutive dots, or end with dot. Ensures that the domain part does not have consecutive dots.
Ensures that the local part does not exceed 64 characters.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Match^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$Length3 <= length <= 254

phonesobject<phone_detail>[]Optional

The invoice recipient's phone numbers. Extension number is not supported.

Items0 <= length <= 32767

languagestring<language>Optional

The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

The billing information of the invoice recipient. Includes name, address, email, phone, and language.

orthographyenum<orthography>Optional

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

addressobject<address_portable>Optional

address_portable properties

10 properties

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

address_detailsobject<Address Details>Optional

email_addressstring<restrictive_email_address>Optional

Allows alphanumeric and RFC-allowed special characters, !#$%&'*+-/=?^_`{|}~
Ensures that the local part does not start with dot (.), have consecutive dots, or end with dot. Ensures that the domain part does not have consecutive dots.
Ensures that the local part does not exceed 64 characters.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Match^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$Length3 <= length <= 254

phonesobject<phone_detail>[]Optional

The invoice recipient's phone numbers. Extension number is not supported.

Items0 <= length <= 32767

languagestring<language>Optional

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

billing_info

person_name properties

address_portable properties

Address Details properties

phone_detail properties

Back to top

On this page

On this page

billing_info

person_name properties

address_portable properties

Address Details properties

phone_detail properties

Back to top

On this page

billing_info

person_name properties

address_portable properties

Address Details properties

phone_detail properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

billing_info

person_name properties

address_portable properties

Address Details properties

phone_detail properties

Back to top

On this page