Object Index
You are viewing an old version of the API
InvoicePaymentRequest
Object Index
Represents a payment request for an invoice.
Invoices can specify a maximum
of 13 payment requests, with up to 12 INSTALLMENT
request types. For more information,
see Payment requests.
Adding INSTALLMENT
payment requests to an invoice requires an
Invoices Plus subscription.
Properties
Name | Description |
---|---|
uid
|
The Square-generated ID of the payment request in an invoice. |
request_
Deprecated
|
Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the
One of the following is required when creating an invoice:
|
request_
|
Identifies the payment request type. This type defines how the payment request amount is determined. This field is required to create a payment request. |
due_
|
The due date (in the invoice's time zone) for the payment request, in After this date, the invoice becomes overdue. For example, a payment |
fixed_
|
If the payment request specifies |
percentage_
|
Specifies the amount for the payment request in percentage:
You cannot specify this when the payment |
tipping_
|
If set to true, the Square-hosted invoice page (the This field is allowed only on the final payment request |
automatic_
|
The payment method for an automatic payment. The default value is |
card_
|
The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,
call ListCards and include the |
reminders
|
A list of one or more reminders to send for the payment request. |
computed_
|
Read only The amount of the payment request, computed using the order amount and information from the various payment
request fields ( |
total_
|
Read only The amount of money already paid for the specific payment request.
This amount might include a rounding adjustment if the most recent invoice payment
was in cash in a currency that rounds cash payments (such as, |
rounding_
|
Read only If the most recent payment was a cash payment
in a currency that rounds cash payments (such as, |