On this page
No Headings
The billing information of the invoice recipient.
Note: This value is an array with only one element.
arrayitemsobjectThe billing information for the invoice recipient.
emailstringemailThe invoice recipient email address. If you omit this value, the invoice is payable and a notification email is not sent.
phoneobjectThe invoice recipient's phone number.
country_codestring^[0-9]{1,3}?$The country code portion of the phone number, in E.164 format.
national_numberstring^[0-9]{1,14}?$The in-country phone number, in E.164 format.
first_namestringThe invoice recipient's first name.
last_namestringThe invoice recipient's last name.
business_namestringThe invoice recipient's business name.
addressobjectThe invoice recipient's billing address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
country_coderequiredstringThe two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas is used in that country's top-level domain names. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringphonestringphoneThe phone number, in its canonical international E.164 numbering plan format.
languagestring"da_DK", "de_DE", "en_AU", "en_GB", "en_US", "es_ES", "es_XC", "fr_CA", "fr_FR", "fr_XC", "he_IL", "id_ID", "it_IT", "ja_JP", "nl_NL", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ru_RU", "sv_SE", "th_TH", "tr_TR", "zh_CN", "zh_HK", "zh_TW", "zh_XC"The language in which the invoice recipient's email appears. Used only when the recipient does not have a PayPal account.
If you omit the language and the recipient does not have a PayPal account, the email is sent in the language of the merchant's PayPal account.
additional_infostringAny additional information about the recipient.