`paypal_list_invoices`

Pack: paypal · Endpoint: https://gateway.pipeworx.io/paypal/mcp

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/paypal_list_invoices for the schema, then POST the same URL with its arguments for the data.

List your PayPal invoices. Returns invoice numbers, amounts, statuses, and dates. Use to track billing and outstanding payments.

Parameters

Name	Type	Required	Description
`_clientId`	string	yes	PayPal app Client ID
`_clientSecret`	string	yes	PayPal app Client Secret
`_sandbox`	boolean	no	Use sandbox environment (default: false)
`page`	number	no	Page number (default 1)
`page_size`	number	no	Results per page (default 20, max 100)

Example call

Arguments

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret"
}

curl

curl -X POST https://gateway.pipeworx.io/paypal/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"paypal_list_invoices","arguments":{"_clientId":"your-paypal-client-id","_clientSecret":"your-paypal-client-secret"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('paypal_list_invoices', {
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret"
});

More examples

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "page": 2,
  "page_size": 50
}

Response shape

Field	Type	Description
`items`	array	Array of invoices
`total_items`	number	Total number of invoices
`total_pages`	number	Total number of pages
`page`	number	Current page number

Full JSON Schema

{
  "type": "object",
  "description": "List of PayPal invoices",
  "properties": {
    "items": {
      "type": "array",
      "description": "Array of invoices",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Invoice ID"
          },
          "number": {
            "type": "string",
            "description": "Invoice number"
          },
          "status": {
            "type": "string",
            "description": "Invoice status (e.g., DRAFT, SENT, PAID, CANCELLED)"
          },
          "amount": {
            "type": "object",
            "properties": {
              "currency_code": {
                "type": "string",
                "description": "Currency code"
              },
              "value": {
                "type": "string",
                "description": "Total invoice amount"
              }
            }
          },
          "due_date": {
            "type": "string",
            "description": "Due date in ISO 8601 format"
          },
          "create_time": {
            "type": "string",
            "description": "Creation timestamp"
          },
          "update_time": {
            "type": "string",
            "description": "Last update timestamp"
          }
        }
      }
    },
    "total_items": {
      "type": "number",
      "description": "Total number of invoices"
    },
    "total_pages": {
      "type": "number",
      "description": "Total number of pages"
    },
    "page": {
      "type": "number",
      "description": "Current page number"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "paypal": {
      "url": "https://gateway.pipeworx.io/paypal/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

paypal_list_invoices