<- Object

Object

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.

Link to section

Properties

Link to section

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
Link to section

given_name

string

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

Link to section

family_name

string

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

Link to section

email_address

string

Read only The recipient's email address.

Link to section

address

Read only The recipient's physical address.

Show attributes
Link to section

phone_number

string

Read only The recipient's phone number.

Link to section

company_name

string

Read only The name of the recipient's company.

Link to section

tax_ids

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.

Show attributes