Send invoice

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.

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 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 to true.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Path Parameters

invoice_id*string

The ID of the draft invoice to delete.

Match^.*$

Length0 <= length <= 2147483647

Request Body

application/json

The email or SMS notification to send to the payer when they send an invoice..

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v2/invoicing/invoices/string/send" \  -H "Content-Type: application/json" \  -d '{}'

{
  "href": "string",
  "rel": "string",
  "method": "GET"
}

{
  "href": "string",
  "rel": "string",
  "method": "GET"
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

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.

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 to true.

Path Parameters

invoice_id*string

The ID of the draft invoice to delete.

Match^.*$

Length0 <= length <= 2147483647

Request Body

application/json

The email or SMS notification to send to the payer when they send an invoice..

TypeScript Definitions

Use the request body type in TypeScript.

subject?string

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

Match^[\S\s]*$

Length0 <= length <= 4000

note?string

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

Match^[\S\s]*$

Length0 <= length <= 4000

send_to_invoicer?boolean

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

Defaultfalse

send_to_recipient?boolean

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

Defaulttrue

additional_recipients?array<>

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.Note: Valid values are email addresses in the additional_recipients value associated with the invoice.

Items0 <= items <= 100

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "NOT_AUTHORIZED", "message": "Authorization failed due to insufficient permissions.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "RESOURCE_NOT_FOUND", "message": "The specified resource does not exist.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] }

Send invoice

200application/json

202application/json

400application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Send invoice

200application/json

202application/json

400application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

`application/json`

`application/json`