Send invoice
POST {{base_url}}/v2/invoicing/invoices/:invoice_id/send
Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:
- If the invoice issue date is current or in the past, sends the invoice immediately.
- If the invoice issue date is in the future, schedules the invoice to be sent on that date.
send_to_invoicer
body parameter to
false
. To send the invoice through a share link and not through PayPal, set the
send
to
recipient
parameter to
false
in the
notification
object. The
send
to
recipient
parameter does not apply to a future issue date because the invoice is scheduled to be sent through PayPal on that date.
Notes:
- After you send an invoice, resending it has no effect.
- To send a notification for updates, update the invoice and set the
send to recipient
body parameter totrue
.
Request Body
{"subject"=>"<The subject of the email that is sent as a notification to the recipient.>", "note"=>"<A note to the payer.>", "send_to_recipient"=>true, "additional_recipients"=>["recipient_cc1@example.com", "recipient_cc2@example.com"], "send_to_invoicer"=>false}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type
| string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. |
| PayPal-Request-Id
| string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. |
| PayPal-Client-Metadata-Id
| string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. |
| PayPal-Partner-Attribution-Id
| string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. |
| PayPal-Auth-Assertion
| string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
|
| Prefer
| string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
| Prefer
| string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: ``