• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
InvoiceRecipient

Represents a snapshot of customer data.

This object stores customer data that is displayed on the invoice and that Square uses to deliver the invoice.

When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates the remaining InvoiceRecipient fields. You cannot update these fields after the invoice is published. Square updates the customer ID in response to a merge operation, but does not update other fields.

Properties

Name Description
customer_id
string

The ID of the customer. This is the customer profile ID that you provide when creating a draft invoice.

Min Length 1 Max Length 255
given_name
string

Read only The recipient's given (that is, first) name.

family_name
string

Read only The recipient's family (that is, last) name.

email_address
string

Read only The recipient's email address.

address
Address

Read only The recipient's physical address.

phone_number
string

Read only The recipient's phone number.

company_name
string

Read only The name of the recipient's company.

tax_ids
InvoiceRecipientTaxIds

Read only The recipient's tax IDs. The country of the seller account determines whether this field is available for the customer. For more information, see Invoice recipient tax IDs.