Paypal

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 No Content with no response body. This action is idempotent - activating an already active plan returns success.

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 shipping updates when fulfilling multiple orders. The action supports up to 20 trackers per request. The response includes tracker identifiers for successfully processed entries and any errors for entries that failed validation or processing. **Required fields:** - trackers: An array containing at least one tracker object **Each tracker requires:** - transaction_id: The PayPal transaction ID - status: The shipment status (CLICKED, SHIPPED, DELIVERED, etc.)

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 a later time, such as when goods are shipped or services are delivered. The authorization creates a hold on the payer's funds and returns authorization details including an authorization ID that can be used later to capture or void the payment. Authorizations are typically valid for 3 days for most payment sources, though this may vary. Use this action after an order has been created and approved by the payer, when you want to authorize but not immediately capture the payment.

Cancels a sent PayPal invoice and optionally notifies relevant parties. Use this action when you need to cancel an invoice that has already been sent to a payer. The action allows you to provide a cancellation reason and control who receives email notifications about the cancellation (recipient, invoicer, and additional CC recipients). This action is irreversible — once canceled, the invoice cannot be reinstated and the payer will no longer be able to pay it through PayPal. Note: Only invoices in SENT or SCHEDULED status can be canceled. Draft invoices should be deleted instead, and paid invoices must be refunded.

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 longer relevant, or when you want to handle payment follow-ups manually. Note: This action only cancels future scheduled reminders. It does not affect reminders that have already been sent.

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 subscriptions that have an outstanding balance to be charged. The capture type must be OUTSTANDING_BALANCE, and you must provide the amount to capture along with a note explaining the reason for the charge.

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 funds into your merchant account. This creates a Braintree transaction and begins the settlement process. The payment method ID should be obtained from a previous tokenization operation using the Braintree client SDK (e.g., `hostedFields.tokenize()` or PayPal button). Note: This action is irreversible once the transaction is successfully captured.

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.currency_code: The three-character currency code (e.g., "USD") **Optional fields:** - detail.invoice_number: Custom invoice number - detail.invoice_date: Date when invoice was issued - detail.note: Note to the payer - detail.terms_and_conditions: Payment terms - items: List of line items (name, quantity, unit_amount required) - primary_recipients: Billing information for recipients - amount: Invoice amount breakdown The created invoice can be modified, scheduled, or sent using other PayPal invoicing actions.

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 action returns the created payment object including approval URLs for the buyer to complete the payment. After the buyer approves the payment, execute it to complete the transaction. Note: This is an irreversible operation once the payment is executed.

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 custom payment preferences. After creation, the plan must be activated via the activate_plan action before it can be used in billing agreements. Note: This uses the legacy /v1/payments/billing-plans endpoint. For newer integrations, consider using the /v1/billing/plans endpoint instead.

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 associated with an existing product. The action returns the created plan object with its unique ID and status.

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 associate plans and pricing with this product. Use this action when you want to create a new product entry in PayPal's catalog system for selling physical items, digital products, or services through PayPal's payment infrastructure.

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 the subscription by logging into their PayPal account and confirming the payment. This action is irreversible once the subscriber approves the subscription. **Required fields:** - plan_id: The PayPal billing plan ID **Important:** - The subscriber will be redirected to PayPal to approve the subscription - Use the 'approve' link from the response to redirect the subscriber - The subscription status will be 'PENDING' until the subscriber approves it

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. **Required fields:** - name: The template name (must be unique) - template_info.detail.currency_code: The three-character ISO-4217 currency code **Optional fields:** - default_template: Set as the default template (only one allowed per account) - standard_template: Indicates if this is a custom template - template_info: Full template configuration - invoicer: Business information (email, tax_id, logo_url, etc.) - primary_recipients: Billing/shipping information for recipients - items: Line item presets - configuration: Tax settings, partial payment options - settings: Display preferences - unit_of_measure: QUANTITY, HOURS, or AMOUNT The created template can be used with the Generate Invoice action to quickly create invoices from pre-configured templates.

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 subscription changes. The webhook URL must be publicly accessible and support HTTPS. The action returns the created webhook object including its unique ID for later reference.

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 useful for testing webhook configurations or verifying webhook authenticity before enabling it in production. This is a create operation that returns the newly created webhook lookup details, including the lookup ID, client ID, and related HATEOAS links. The action requires no input parameters.

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 and brand name, input field customization, and checkout flow behavior. The profile can be set as temporary (persists for three hours) or permanent. To use this profile, pass its ID when creating a payment.

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 will continue to work, but no new subscriptions can be created with this plan. Note: Only plans in an ACTIVE state can be deactivated. Deactivated plans cannot be reactivated.

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 payment record cannot be recovered. A successful deletion returns HTTP 204 No Content with no JSON response body. This action is idempotent — attempting to delete a non-existent payment record also returns success.

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 be lost. Note: Only draft invoices can be deleted. Attempting to delete an invoice that has been sent or paid will return an error.

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. This action is irreversible — once deleted, the payment record cannot be recovered. A successful deletion returns HTTP 204 No Content with no response body. This action is idempotent — attempting to delete a non-existent payment record also returns success.

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 invoice payment history. Note: This action only deletes the refund record reference from the invoice. It does not reverse or refund the actual payment through PayPal.

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 valid state can be deleted. Attempting to delete a resource that is already deleted or does not exist will return an error.

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 recreated if needed again. Note: Only templates that are not currently in use can be deleted. Attempting to delete a template that is associated with active invoices may return an error.

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 notifications immediately. Note: Deleting a webhook does not affect any events that were already processed by that webhook. Only future events will be affected.

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 deleted. Note: Only web profiles that are not currently in use can be deleted. Attempting to delete a profile that is associated with an active resource will return an error.

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 GraphQL query against the Braintree API to fetch the node and its associated data. Note: This action uses the Braintree GraphQL API endpoint at /graphql. The node ID should be the base64-encoded global ID from Braintree. Different node types return different fields in the response.

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 a status of OPEN can be finalized. This action must be performed before the reply-by date deadline. Once finalized, the dispute cannot be modified or additional evidence added. Note: This action uses the Braintree GraphQL API endpoint, which is separate from the standard PayPal REST API.

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 details. This is useful for displaying appropriate payment options during checkout or determining payment eligibility before creating an order. The response includes available payment methods and optionally vaulted tokens if the customer has saved payment instruments. **Common use cases:** - Pre-checkout payment method availability - Display appropriate payment options to customers - Determine eligible funding sources for a transaction

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.Buttons() or paypal.Messages()) in your web application. This action requires no request body parameters - the token is generated based on your authenticated credentials (Bearer token in Authorization header). Note: Client tokens are short-lived and should be fetched fresh before each checkout session. Do not cache or reuse client tokens across multiple sessions.

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 across your PayPal invoices. Note: This action queries PayPal for the next available invoice number in your sequence. The format is configured in your PayPal account settings.

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 invoice numbering across your PayPal invoices. Note: This action queries PayPal for the next available invoice number in your sequence. The format is configured in your PayPal account settings.

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 contains encoded payment information that redirects users to PayPal to complete the transaction. **Customization options:** - Adjust dimensions using the `width` and `height` parameters (150-500 pixels) - Choose between payment URL (`action='pay'`) or details URL (`action='details'`) Note: This action uses the PayPal Invoicing API v2, which is the recommended version for new integrations.

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_size parameters. Set total_required=true to include total item and page counts in the response.

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 for verifying invoice details, tracking payment status, or auditing invoice information. This is a read-only operation that returns the complete invoice details including invoicer information, recipient details, items, amounts, payments, refunds, and HATEOAS links for related actions. Note: The invoice ID is a path parameter, not a query parameter.

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 complete the payment. You can customize the QR code dimensions using the width and height parameters. Note: The PayPal Invoicing v1 API is deprecated. Consider migrating to the v2 API for new integrations.

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, line items, amounts), or whether it is the default template. This is useful for verifying template configuration before creating invoices, auditing template settings, or retrieving template details for display purposes. This is a read-only operation that returns the complete template details including the template name, settings, template_info (invoicer business info, recipients, items, amounts, configuration), HATEOAS links, and whether it is a default or standard template. Note: The template_id is a path parameter, not a query parameter.

Retrieves detailed information about a specific PayPal order by its ID. Use this action when you need to check the status, payment details, purchase units, payer information, or other properties of an existing order. The order details include the order status, intent (capture or authorize), purchase unit details (items, amounts, shipping), payer information, and HATEOAS links for available actions. You can optionally request the payment_source field using the fields parameter.

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 verifying payment details, checking if a payment was approved, viewing transaction amounts, or accessing related sale/authorization/capture resources. Note that this is a deprecated v1 API endpoint — consider using the v2 Payments API for new integrations.

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. Note that this is a deprecated v1 API endpoint.

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.

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 creating plans or subscriptions.

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 fields like 'last_failed_payment' or 'plan' details using the fields parameter.

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 associated with the OAuth access token provided in the Authorization header. The access token must have been obtained via OpenID Connect authentication flow. This action requires an access token with the 'openid' scope. The token is passed via the Authorization header (Bearer token), which is automatically injected from the auth_metadata.

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 supported schema value is 'paypalv1.1', which returns the user information in a structured format.

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 useful for auditing webhook settings, verifying webhook subscriptions, or checking webhook configuration. This is a read-only operation that returns the webhook details including its ID, URL, subscribed event types, and HATEOAS links for related actions.

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 webhook lookup information or auditing webhook lookup records. This is a read-only operation that returns the webhook lookup details including the lookup ID, client ID, and related links for navigation.

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. This is useful for auditing profile settings, verifying configurations, or retrieving profile information before updating. This is a read-only operation that returns the web profile details including its ID, name, flow config, input fields, presentation settings, and temporary status.

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. Results are sorted by creation time (newest first). Use the next_page_token from response links to paginate through additional results.

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 total counts in the response by setting total_required=true. This action supports filtering fields to return either all invoice details (fields='all') or only the essential information like name, ID, and defaults (fields='none').

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 including payment definitions, merchant preferences, and status. Note: This action uses the legacy API endpoint. For newer integrations, consider using the /v1/billing/plans endpoint instead.

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 building payment dashboards. Results are paginated and can be filtered by various criteria including creation time, payer ID, and payment status. NOTE: This endpoint is deprecated. For new integrations, use /v1/payments/captures and /v1/payments/authorizations instead.

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, billing cycles, and status. Results can be filtered by product_id and paginated using page and page_size parameters. The response includes HATEOAS links for navigating between pages and performing related actions (e.g., activate, deactivate, update plan).

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, names, and descriptions. This action supports pagination via page_size and page parameters. Set total_required=true to include total item and page counts in the response.

List invoice templates from PayPal. Use when you need to retrieve a paginated list of PayPal invoice templates with their details. This is a read-only operation that returns template information including names, IDs, settings, and default status. The action supports pagination via page and page_size parameters, and you can control which fields are returned using the fields parameter (set to 'none' for minimal template info).

Lists all available PayPal webhook event types to which you can subscribe. Use this action when you need to discover all webhook events available in the PayPal API before creating or configuring webhooks. This is useful for initial setup or when you need to display available webhook options to users. The endpoint requires no parameters and returns the full list of supported event types with their descriptions and statuses. This is a read-only operation that queries available events without modifying anything.

Lists event type subscriptions for a specific PayPal webhook. Use this action when you need to retrieve the list of event types to which a specific webhook is subscribed. This is useful for auditing webhook configurations, verifying which events a webhook is set up to receive, or checking the status of event subscriptions. Unlike the ListWebhookEventTypes action which lists all available event types, this action returns only the event types that a specific webhook is subscribed to. This is a read-only operation that does not modify any webhook configuration.

Lists all webhook lookups associated with your PayPal application. Use this action when you need to retrieve webhook lookups that have been configured for your application. This is useful for auditing webhook configurations, verifying lookup status, or checking which client IDs have registered webhooks. This is a read-only operation that returns webhook lookup details including IDs, client IDs, and HATEOAS links for related actions. The action requires no input parameters.

Lists webhooks configured for an application or PayPal account. Use this action when you need to retrieve all webhooks that have been created and configured in your PayPal integration. This is useful for auditing existing webhook configurations, verifying webhook subscriptions, or checking webhook status. The results can be filtered by anchor_type to show webhooks for the application (APPLICATION) or a specific account (ACCOUNT). This is a read-only operation that returns webhook details including URLs, subscribed event types, and HATEOAS links for related actions.

Lists web experience profiles from PayPal with optional pagination. Use this action when you need to retrieve available web experience profiles for customizing the checkout experience. This is a read-only operation that returns profile details including flow configuration, input field settings, and branding options. Results can be paginated using page and page_size parameters. The response includes up to 20 profiles by default (configurable via page_size), with HATEOAS links for pagination if more results exist.