On this page
No Headings
The billing and shipping information. Includes name, email, address, phone, and language.
objectbilling_infoobjectThe billing information of the invoice recipient. Includes name, address, email, phone, and language.
email_addressobject^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$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.
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.
The invoice recipient email address. If you omit this value, the invoice is payable and a notification email is not sent.
phonesarrayThe invoice recipient's phone numbers. Extension number is not supported.
itemsobjectThe phone details. Includes the phone number and type.
additional_infostring^[\S\s]*$Any additional information about the recipient.
languageobject^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$The language tag 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, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
The language in which to show the invoice recipient's email message. 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 message is sent in the language of the merchant's PayPal account.
shipping_infoobjectThe contact information of the user. Includes name and address.
The recipient's shipping information. Includes the user's contact information, which includes name and address.