<- Enum

Enum

All versions ->

InvoiceStatusBeta

Indicates the status of an invoice.

Link to section

Values

Link to section

DRAFT

The invoice is a draft. You must publish a draft invoice before Square can process it. A draft invoice has no public_url, so it is not available to customers.

Link to section

UNPAID

The invoice is published but not yet paid.

Link to section

SCHEDULED

The invoice is scheduled to be processed. On the scheduled date, Square emails the invoice (if the request_method is EMAIL), charges the customer's card (if the request_method is CHARGE_CARD_ON_FILE), or takes no action (if the request_method is SHARE_MANUALLY). The invoice status then changes accordingly (UNPAID, PAID, or PARTIALLY_PAID).

Link to section

PARTIALLY_PAID

A partial payment is received for the invoice.

Link to section

PAID

The customer paid the invoice in full.

Link to section

PARTIALLY_REFUNDED

The invoice is paid (or partially paid) and some but not all the amount paid is refunded.

Link to section

REFUNDED

The full amount that the customer paid for the invoice is refunded.

Link to section

CANCELED

The invoice is canceled. Square no longer requests payments from the customer. The public_url page remains and is accessible, but it displays the invoice as cancelled and does not accept payment.

Link to section

FAILED

Square canceled the invoice due to suspicious activity.

Link to section

PAYMENT_PENDING

A payment on the invoice was initiated but has not yet been processed.

When in this state, invoices cannot be updated and other payments cannot be initiated.