Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
invoices

Send invoice

Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:<ul><li>If the invoice issue date is current or in the past, sends the invoice immediately.</li><li>If the invoice issue date is in the future, schedules the invoice to be sent on that date.</li></ul>To suppress the merchant's email notification, set the send_to_invoicer body parameter to false. To send the invoice through a share link and not through PayPal, set the <code>send_to_recipient</code> parameter to <code>false</code> in the <code>notification</code> object. The <code>send_to_recipient</code> parameter does not apply to a future issue date because the invoice is scheduled to be sent through PayPal on that date.<blockquote><strong>Notes:</strong><ul><li>After you send an invoice, resending it has no effect.</li><li>To send a notification for updates, <a href="#invoices_update">update the invoice</a> and set the <code>send_to_recipient</code> body parameter to <code>true</code>.</li></ul></blockquote>

post/v2/invoicing/invoices/{invoice_id}/send

Path parameters

invoice_idstring required

The ID of the draft invoice to delete.

Request body

subjectstring

The subject of the email that is sent as a notification to the recipient.<blockquote><strong>Note:</strong> User-provided values for this field will not be honored and the subject will always be defaulted to a system-defined value.</blockquote>

notestring

A note to the payer.<blockquote><strong>Note:</strong> User-provided values for this field will not be honored and the note will always be defaulted to a system-defined value.</blockquote>

send_to_invoicerboolean

Indicates whether to send a copy of the email to the merchant.

send_to_recipientboolean

Indicates whether to send a copy of the email to the recipient.

additional_recipientsEmailAddress[]

An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.<blockquote><strong>Note:</strong> Valid values are email addresses in the additional_recipients value associated with the invoice.</blockquote>

Response

A successful request returns the HTTP 200 OK when the invoice issue date is current date.

hrefstring required

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

relstring required

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'PATCH'

The HTTP method required to make the related call.