update-invoice-request.md

Update Invoice Request

Describes a UpdateInvoice request.

Structure

Update Invoice Request

Fields

Name	Type	Tags	Description
invoice	Invoice	Required	Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see Invoices API Overview.
idempotency_key	str	Optional	A unique string that identifies the UpdateInvoice request. If you do not provide idempotency_key (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see Idempotency. Constraints: Maximum Length: 128
fields_to_clear	List[str]	Optional	The list of fields to clear. Although this field is currently supported, we recommend using null values or the remove field when possible. For examples, see Update an Invoice.

Example (as JSON)

{
  "idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be",
  "invoice": {
    "payment_requests": [
      {
        "reminders": null,
        "tipping_enabled": false,
        "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
      }
    ],
    "version": 1,
    "id": "id6",
    "location_id": "location_id0",
    "order_id": "order_id0",
    "primary_recipient": {
      "customer_id": "customer_id2",
      "given_name": "given_name6",
      "family_name": "family_name8",
      "email_address": "email_address2",
      "address": {
        "address_line_1": "address_line_16",
        "address_line_2": "address_line_26",
        "address_line_3": "address_line_32",
        "locality": "locality6",
        "sublocality": "sublocality6"
      }
    }
  },
  "fields_to_clear": [
    "fields_to_clear1",
    "fields_to_clear2",
    "fields_to_clear3"
  ]
}