Note: This model is in beta.
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.
| Name | Type | Description | Notes |
|---|---|---|---|
| uid | String | The Square-generated ID of the payment request in an `invoice`. | [optional] |
| request_method | String | Indicates how Square processes the payment request. See InvoiceRequestMethod for possible values | [optional] |
| request_type | String | Identifies the payment request type. This type defines how the payment request amount is determined. See InvoiceRequestType for possible values | [optional] |
| due_date | String | The due date (in the invoice location's time zone) for the payment request. After this date, the invoice becomes overdue. | [optional] |
| fixed_amount_requested_money | Money | If the payment request specifies `DEPOSIT` or `INSTALLMENT` as the `request_type`, this indicates the request amount. You cannot specify this when `request_type` is `BALANCE` or when the payment request includes the `percentage_requested` field. | [optional] |
| percentage_requested | String | Specifies the amount for the payment request in percentage: - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order total amount. - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order total less the deposit, if requested. The sum of the `percentage_requested` in all installment payment requests must be equal to 100. You cannot specify this when the payment `request_type` is `BALANCE` or when the payment request specifies the `fixed_amount_requested_money` field. | [optional] |
| tipping_enabled | Boolean | If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) provides a place for the customer to pay a tip. This field is allowed only on the final payment request and the payment `request_type` must be `BALANCE` or `INSTALLMENT`. | [optional] |
| card_id | String | The ID of the card on file to charge for the payment request. To get the customer’s card on file, use the `customer_id` of the invoice recipient to call `RetrieveCustomer` in the Customers API. Then, get the ID of the target card from the `cards` field in the response. | [optional] |
| reminders | [InvoicePaymentReminder] | A list of one or more reminders to send for the payment request. | [optional] |
| computed_amount_money | Money | The amount of the payment request, computed using the order amount and information from the various payment request fields (`request_type`, `fixed_amount_requested_money`, and `percentage_requested`). | [optional] |
| total_completed_amount_money | Money | 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, `CAD` or `AUD`). | [optional] |
| rounding_adjustment_included_money | Money | If the most recent payment was a cash payment in a currency that rounds cash payments (such as, `CAD` or `AUD`) and the payment is rounded from `computed_amount_money` in the payment request, then this field specifies the rounding adjustment applied. This amount might be negative. | [optional] |