Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.13 KB

invoice-custom-field.md

File metadata and controls

31 lines (21 loc) · 1.13 KB

Invoice Custom Field

An additional seller-defined and customer-facing field to include on the invoice. For more information, see Custom fields.

Adding custom fields to an invoice requires an Invoices Plus subscription.

Structure

InvoiceCustomField

Fields

Name Type Tags Description
label string | undefined Optional The label or title of the custom field. This field is required for a custom field.
Constraints: Maximum Length: 30
value string | undefined Optional The text of the custom field. If omitted, only the label is rendered.
Constraints: Maximum Length: 2000
placement string | undefined Optional Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF
copies of the invoice.

Example (as JSON)

{
  "label": null,
  "value": null,
  "placement": null
}