paypal · 78 tools · no triggers
Connect it
run auth paypal
run auth paypal --scope team # shared with the organization
Use it
run paypal # common commands
run paypal --all # every command
import { paypal } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
activate-plan | Activates a billing plan in PayPal, making it available for subscription signups. |
authorize-order | Authorizes payment for an order. Use this action when you need to authorize funds from a payer’s payment source but delay capturing the payment until… |
cancel-invoice | Cancels a sent PayPal invoice and optionally notifies relevant parties. |
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. |
get-order | Retrieves detailed information about a specific PayPal order by its ID. |
get-payments-refund | Retrieves details for a PayPal refund by its ID. Use when you need to check the status, amount, or details of an existing refund. |
get-subscription | Retrieves the details of a PayPal subscription by its ID. Use this action when you need to check the status, billing information, subscriber details… |
send-invoice | Sends a PayPal invoice to the recipient via email. Use this action when you need to send a draft invoice to the recipient. |
All 78 tools
All 78 tools
| Tool | What it does |
|---|---|
activate-plan | Activates a billing plan in PayPal, making it available for subscription signups. |
add-batch-trackers | Add tracking information for multiple PayPal transactions in a single request. |
authorize-order | Authorizes payment for an order. Use this action when you need to authorize funds from a payer’s payment source but delay capturing the payment until… |
cancel-invoice | Cancels a sent PayPal invoice and optionally notifies relevant parties. |
cancel-reminders | Cancels the automatic payment reminders for a PayPal invoice. |
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… |
charge-payment-method | Charges a payment method and captures funds immediately using Braintree GraphQL API. |
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. |
create-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. |
create-payments-billing-plans | Creates a PayPal billing plan using the legacy payments API (POST /v1/payments/billing-plans). |
create-plan | Creates a PayPal billing plan for subscription billing. Use this action when setting up new subscription pricing plans in PayPal, including plans… |
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. |
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. |
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. |
create-webhook | Creates a PayPal webhook endpoint to receive notifications about events. |
create-webhook-lookup | Creates a new PayPal webhook lookup to verify a webhook signature. |
create-web-profile | Creates a PayPal web experience profile for customizing checkout. |
deactivate-plan | Deactivates a PayPal billing plan, making it unavailable for new subscriptions while preserving existing subscriptions. |
delete-external-payment | Permanently deletes an external payment from a specified PayPal invoice. |
delete-invoice | Deletes a PayPal invoice by its ID. Use this action when you need to permanently remove an invoice that is no longer needed. |
delete-invoice-payment-record | 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. |
delete-invoice-refund-record | Permanently deletes a refund record from a specified PayPal invoice. |
delete-payment-resource | Deletes a PayPal payment resource. Use when you need to permanently remove a payment resource that is no longer needed. |
delete-template | 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. |
delete-webhook | Deletes a PayPal webhook by its ID. Use this action when you need to permanently remove a webhook endpoint that is no longer needed. |
delete-web-profile | 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. |
fetch-node | Fetches any object that extends the Node interface using its ID. |
finalize-pay-pal-braintree-dispute | Finalizes a Braintree dispute after adding evidence, submitting it to the cardholder’s bank for review. |
find-eligible-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… |
generate-client-token | Generate a client token for PayPal JavaScript SDK integration. |
generate-next-invoice-number | Generates the next invoice number from PayPal’s invoicing service. |
generate-next-invoice-number-v2 | Generates the next invoice number from PayPal’s invoicing service using the v2 API. |
generate-qr-code | Generates a QR code image for a PayPal invoice using the v2 invoicing API. |
get-billing-subscriptions | Lists PayPal billing subscriptions for the merchant account. |
get-invoice | Retrieves detailed information about a specific PayPal invoice by its ID. |
get-invoicing-invoices-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. |
get-invoicing-template | Retrieves detailed information about a specific PayPal invoice template by its ID. |
get-order | Retrieves detailed information about a specific PayPal order by its ID. |
get-payment | Retrieves details for a PayPal payment by its ID using the deprecated v1 Payments API. |
get-payments-refund | Retrieves details for a PayPal refund by its ID. Use when you need to check the status, amount, or details of an existing refund. |
get-plan | Retrieves details for a specific PayPal billing plan by its ID. |
get-product | Retrieves detailed information about a specific PayPal product by its ID. |
get-subscription | Retrieves the details of a PayPal subscription by its ID. Use this action when you need to check the status, billing information, subscriber details… |
get-userinfo | Retrieves user profile information from PayPal. Use when you need to get the authenticated user’s profile details including name, email, address, and… |
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… |
get-webhook | Retrieves detailed information about a specific PayPal webhook by its ID. |
get-webhook-lookup | Retrieves detailed information about a specific PayPal webhook lookup by its ID. |
get-web-profile | Retrieves detailed information about a PayPal web experience profile by its ID. |
list-disputes | List PayPal customer disputes with optional filtering by date, transaction, or state. |
list-invoices | List invoices from PayPal with pagination support. Use when you need to retrieve a paginated list of PayPal invoices. |
list-legacy-billing-plans | Lists billing plans using the legacy PayPal payments API (v1/payments/billing-plans). |
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. |
list-plans | Lists billing plans from PayPal with optional filtering and pagination. |
list-products | List products from the PayPal product catalog. Use when you need to retrieve a paginated list of products with their details, such as product IDs… |
list-templates | List invoice templates from PayPal. Use when you need to retrieve a paginated list of PayPal invoice templates with their details. |
list-webhook-event-types | Lists all available PayPal webhook event types to which you can subscribe. |
list-webhook-event-type-subscriptions | Lists event type subscriptions for a specific PayPal webhook. |
list-webhook-lookups | Lists all webhook lookups associated with your PayPal application. |
list-webhooks | Lists webhooks configured for an application or PayPal account. |
list-web-profiles | Lists web experience profiles from PayPal with optional pagination. |
patch-orders | Partially updates a PayPal checkout order using JSON Patch (RFC 6902) operations. |
patch-plan | Partially updates a PayPal billing plan using JSON Patch (RFC 6902) operations. |
patch-subscription | Update a PayPal subscription using JSON Patch operations. Use when you need to modify specific fields of an existing subscription such as custom_id… |
patch-web-profile | Partially updates a PayPal web experience profile using JSON Patch (RFC 6902) operations. |
ping-braintree | Sends a ping query to the PayPal Braintree GraphQL API. Use when you need to verify connectivity and authentication status with the Braintree GraphQL endpoint. |
query-braintree-report | Queries Braintree reports via GraphQL API. Use this action when you need to retrieve reports from Braintree’s GraphQL API, such as transaction… |
retrieve-payment-resource | Retrieve a PayPal payment resource by its ID. Use this action when you need to fetch details about an existing payment resource created through the… |
search-invoices | Search for PayPal invoices based on various filter criteria. |
send-invoice | Sends a PayPal invoice to the recipient via email. Use this action when you need to send a draft invoice to the recipient. |
simulate-webhook-event | Simulates a webhook event to test your webhook integration. Use this action when you need to verify that your webhook endpoint is correctly… |
update-dispute | Partially update a PayPal dispute using JSON Patch operations. |
update-invoice | Fully updates a PayPal invoice by replacing the entire invoice with the provided data. |
update-pay-pal-product | Partially updates a PayPal product using JSON Patch (RFC 6902) operations. |
update-pay-pal-webhook | Updates a PayPal webhook using JSON Patch (RFC 6902) operations. |
update-templates | Fully updates a PayPal invoice template. Use this action when you need to completely replace an existing template with new values. |
update-web-profile | Updates a PayPal web experience profile. Use this action when you need to modify an existing web experience profile that controls the checkout flow… |
verify-payment-method | Verifies a multi-use payment method to ensure it has passed fraud rules and is associated with a valid account. |
verify-webhook-signature | Verifies the signature of a PayPal webhook notification to confirm its authenticity. |