PayPal

Tools

• Activate billing plan

  Activates a billing plan in PayPal, making it available for subscription signups. Use this action when you have a billing plan in inactive state that you want to make available for new subscriptions. A successful activation returns HTTP 204

• Add Batch Tracking Information

  Add tracking information for multiple PayPal transactions in a single request. Use this action when you need to add or update tracking information for one or more PayPal transactions. This is particularly useful for batch processing shippin

• Cancel Invoice Reminders

  Cancels the automatic payment reminders for a PayPal invoice. Use this action when you need to stop the automatic reminder emails from being sent to the payer for a particular invoice. This is useful when the invoice has been paid, is no lo

• Capture subscription payment

  Captures an authorized payment on a PayPal subscription. Use this action when you need to charge a subscriber for an outstanding balance or capture an authorized payment that was previously approved. This action captures payments for subscr

• Charge Payment Method

  Charges a payment method and captures funds immediately using Braintree GraphQL API. Use this action when you need to charge a customer's stored payment method (credit card, PayPal account, Venmo account, etc.) and immediately capture the f

• Create a billing plan

  Creates a PayPal billing plan for subscription billing. Use this action when setting up new subscription pricing plans in PayPal, including plans with trial periods, regular billing cycles, and custom payment preferences. The plan must be a

• Create a web experience profile

  Creates a PayPal web experience profile for customizing checkout. Use this action when you need to set up a branded, customized checkout experience for PayPal payments. This includes configuring the landing page, branding elements like logo

• Create a webhook

  Creates a PayPal webhook endpoint to receive notifications about events. Use this action when you need to set up a webhook to receive real-time notifications about PayPal events such as payment completions, refunds, disputes, or subscriptio

• Create a webhook lookup

  Creates a new PayPal webhook lookup to verify a webhook signature. Use this action when you need to initiate a webhook lookup to validate that a webhook endpoint is correctly receiving and processing PayPal event notifications. This is usef

• Create billing plan (legacy)

  Creates a PayPal billing plan using the legacy payments API (POST /v1/payments/billing-plans). Use this action when setting up a new billing plan for PayPal billing agreements, including plans with trial periods, regular billing cycles, and

• Create invoice

  Creates a PayPal draft invoice. Use this action when you need to create a new invoice that can be customized and sent to recipients. The invoice is created in DRAFT status and can be modified before being sent. **Required fields:** - detail

• Create PayPal payment

  Creates a PayPal payment using the v1 Payments API. Use this action when you need to create a payment to be processed through PayPal. This action is for the deprecated v1 API - consider using the v2 Payments API for new integrations. The ac

• Create Product

  Creates a new product in PayPal's catalog. Use when you need to set up a product that can be used with PayPal's subscription or payment services. The product can be physical goods, digital goods, or a service. Once created, you can associat

• Create Subscription

  Creates a new PayPal subscription based on a billing plan. Use this action when you need to set up a recurring billing subscription for a customer. The action returns a subscription ID and an approval URL where the subscriber must complete

• Create template

  Creates a PayPal invoice template. Use this action when you need to create a reusable invoice template that can be used to generate invoices with consistent settings. Templates are useful for businesses that regularly send similar invoices.

• Deactivate Plan

  Deactivates a PayPal billing plan, making it unavailable for new subscriptions while preserving existing subscriptions. Use this action when you need to stop offering a particular billing plan without deleting it. Existing subscriptions wil

• Delete Invoice

  destructive

  Deletes a PayPal invoice by its ID. Use this action when you need to permanently remove an invoice that is no longer needed. This action is irreversible — once deleted, the invoice cannot be recovered and any associated payment records will

• Delete Invoice External Payment

  destructive

  Permanently deletes an external payment from a specified PayPal invoice. Use when you need to remove a specific external payment transaction that was incorrectly recorded on an invoice. This action is irreversible — once deleted, the paymen

• Delete invoice payment record

  destructive

  Deletes a payment record from a PayPal invoice. Use this action when you need to remove a specific payment transaction record that was incorrectly applied to an invoice. This action permanently removes the payment record from the invoice. T

• Delete Invoice Refund Record

  destructive

  Permanently deletes a refund record from a specified PayPal invoice. This action is irreversible - once deleted, the refund record cannot be recovered. Use when correcting invoice payment records, removing erroneous refunds, or cleaning up

• Delete Payment Resource

  destructive

  Deletes a PayPal payment resource. Use when you need to permanently remove a payment resource that is no longer needed. This action is irreversible — the payment resource cannot be recovered once deleted. Note: Only payment resources in a v

• Delete Template

  destructive

  Deletes a PayPal invoice template by its ID. Use this action when you need to permanently remove an invoice template that is no longer needed. This action is irreversible — once deleted, the template cannot be recovered and will need to be

• Delete Web Experience Profile

  destructive

  Deletes a PayPal web experience profile by its ID. Use this action when you need to permanently remove a web experience profile that is no longer needed. This action is irreversible — the web experience profile cannot be recovered once dele

• Delete Webhook

  destructive

  Deletes a PayPal webhook by its ID. Use this action when you need to permanently remove a webhook endpoint that is no longer needed. This action is irreversible — once deleted, the webhook cannot be recovered and will stop receiving event n

• Fetch Braintree Node

  Fetches any object that extends the Node interface using its ID. Use this action when you need to retrieve details about a specific Braintree resource (transaction, customer, payment method, etc.) by its global ID. This action performs a Gr

• Finalize Braintree Dispute

  Finalizes a Braintree dispute after adding evidence, submitting it to the cardholder's bank for review. Use this action when you have finished adding evidence to an OPEN dispute and want to formally submit it for review. Only disputes with

• Find eligible PayPal payment methods

  Find a list of eligible payment methods for a customer. Use this action when you need to determine which payment methods (such as PayPal, PayPal Credit, Pay Later, or Venmo) are available for a customer based on their country and purchase d

• Generate Invoice QR Code

  Generates a QR code image for a PayPal invoice using the v2 invoicing API. Use this action when you need to display a scannable QR code that customers can use to pay an invoice or view its details via the PayPal mobile app. The QR code cont

• Generate Next Invoice Number

  Generates the next invoice number from PayPal's invoicing service. Use this action when you need to retrieve the next sequential invoice number in your customized format before creating an invoice. This ensures consistent invoice numbering

• Generate Next Invoice Number (v2)

  Generates the next invoice number from PayPal's invoicing service using the v2 API. Use this action when you need to retrieve the next sequential invoice number in your customized format before creating an invoice. This ensures consistent i

• Generate PayPal Client Token

  Generate a client token for PayPal JavaScript SDK integration. Use this action when you need to obtain a client token for accepting PayPal payments on the client side. The client token is required when initializing the PayPal JS SDK (paypal

• Get Invoice

  Retrieves detailed information about a specific PayPal invoice by its ID. Use this action when you need to get details about an existing invoice, such as its status, amount, line items, payment history, or refund information. This is useful

• Get Invoice QR Code

  Generates a QR code image for a PayPal invoice. Use this action when you need to display a scannable QR code that customers can use to pay an invoice. The QR code contains encoded payment information that redirects customers to PayPal to co

• Get Invoice Template

  Retrieves detailed information about a specific PayPal invoice template by its ID. Use this action when you need to get details about an existing invoice template, such as its name, settings, template info (invoicer details, recipients, lin

• Get Payment Details

  Retrieves details for a PayPal payment by its ID using the deprecated v1 Payments API. Use when you need to check the status, payer information, transaction details, or related resources of an existing payment. This action is useful for ver

• Get PayPal User Info

  Retrieves user claims from PayPal using OpenID Connect. Use when you need to obtain authenticated user's profile information such as email, name, and address based on an access token. This endpoint returns user identity information associat

• Get Plan

  Retrieves details for a specific PayPal billing plan by its ID. Use when you need to fetch information about an existing subscription plan, such as its pricing, billing cycles, status, or payment preferences.

• Get Product

  Retrieves detailed information about a specific PayPal product by its ID. Use when you need to get details about a product, such as its name, description, category, or type. This action is useful for verifying product details before creatin

• Get Refund Details

  Retrieves details for a PayPal refund by its ID. Use when you need to check the status, amount, or details of an existing refund. This action is useful for verifying refund details, checking refund status, or monitoring refund progress. Not

• Get Subscription Details

  Retrieves the details of a PayPal subscription by its ID. Use this action when you need to check the status, billing information, subscriber details, or other properties of an existing subscription. Optionally, you can request additional fi

• Get User Info

  Retrieves user profile information from PayPal. Use when you need to get the authenticated user's profile details including name, email, address, and account verification status. The response is filtered by the specified schema. The only su

• Get Webhook

  Retrieves detailed information about a specific PayPal webhook by its ID. Use this action when you need to get details about an existing webhook configuration, such as the webhook URL, subscribed event types, or webhook status. This is usef

• Get Webhook Lookup

  Retrieves detailed information about a specific PayPal webhook lookup by its ID. Use this action when you need to get details about a webhook lookup, such as its associated client ID and related HATEOAS links. This is useful for verifying w

• Get Web Profile

  Retrieves detailed information about a PayPal web experience profile by its ID. Use when you need to get details about an existing web experience profile, such as its name, flow configuration, input field settings, or presentation style. Th

• List billing plans

  Lists billing plans from PayPal with optional filtering and pagination. Use this action when you need to retrieve available billing plans for subscription products. This is a read-only operation that returns plan details including pricing,

• List Billing Subscriptions

  Lists PayPal billing subscriptions for the merchant account. Use when you need to retrieve a paginated list of subscriptions, optionally filtered by creation date range, status, or plan ID. This action supports pagination via page and page_

• List Legacy Billing Plans

  Lists billing plans using the legacy PayPal payments API (v1/payments/billing-plans). Use when you need to retrieve billing plans created with the legacy PayPal billing agreements API. This is a read-only operation that returns plan details

• List Payments

  Lists payment information for authorized payments. Use when you need to retrieve a list of PayPal payments with optional filtering by time, payer, or status. This action is useful for reconciling transactions, monitoring payment states, and

• List PayPal Disputes

  List PayPal customer disputes with optional filtering by date, transaction, or state. Use when you need to retrieve a paginated list of PayPal disputes. You can filter by creation date, transaction ID, dispute state, or update time range. R

• List PayPal Invoices

  List invoices from PayPal with pagination support. Use when you need to retrieve a paginated list of PayPal invoices. You can control the number of results per page using page_size, navigate through pages using page, and optionally include

Works well with

How Switchy teams use it

Starter prompts

@PayPal capture the authorized payment for subscription ID SUB-98765. Confirm the amount charged and update me on the transaction status.

@PayPal add tracking number 1Z999AA10123456784 with carrier UPS to transaction 8LM45678AB901234C. Mark the shipment status as shipped.

@PayPal activate the billing plan named 'Premium Monthly' that's currently in inactive state. Let me know when it's available for new subscriptions.

@PayPal cancel the automatic payment reminders for invoice INV-2024-0042. Confirm the reminders are stopped and no further emails will send.

@PayPal show me the 10 most recent transactions from the past 7 days. Include transaction ID, amount, status, and payer email for each.

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Use-case deep-dives

Frequently asked