create_invoice
create invoice
Create Invoices on PayPal.
This function creates a draft invoice, specifying a currency code, the invoicer's business information, one or more recipients to bill, and line items. Once created, the invoice can be sent to the customer for payment.
primary_recipients and items use PayPal's real nested shape (billing_info/shipping_info for recipients; unit_amount/tax/discount for items); other fields use a simplified flat shape.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersnoteitemsrequiredallow_tipreferencetheme_colorinvoice_datecurrency_coderequiredinvoicer_cityshipping_costinvoice_numberinvoicer_stateinvoicer_tax_id+13 more
create_recurring_series
create recurring series
Create a recurring invoice series on PayPal.
This function creates a recurring invoice series that automatically generates and sends invoices to a customer on a schedule, specifying a billing frequency, a start date, a currency code, a primary recipient, and line items for the series template.
primary_recipients and items use PayPal's real nested shape (billing_info/shipping_info for recipients; unit_amount/tax/discount for items); other fields use a simplified flat shape.
A newly created series is in DRAFT status and will not generate invoices until activated -- call activate_recurring_series with the returned series ID to activate it.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersnoteitemsallow_tipreferencetotal_cyclescurrency_coderequiredinterval_unitrequiredinvoicer_cityshipping_costinterval_countrequiredinvoicer_stateinvoicer_tax_id+12 more
activate_recurring_series
activate recurring series
Activate a recurring invoice series on PayPal.
This function activates a recurring invoice series by its ID, moving it out of DRAFT status. Once activated, PayPal automatically generates and sends invoices to the customer based on the series' configured schedule. Call this after create_recurring_series to make the series active.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersrecurring_series_idrequired
get_recurring_series
get recurring series
Get a recurring invoice series from PayPal.
This function retrieves details of a specific recurring invoice series using its ID, including its schedule, status, template, and recipient information.
Parametersrecurring_series_idrequired
cancel_recurring_series
cancel recurring series
Cancel a recurring invoice series on PayPal.
This function cancels a recurring invoice series by its ID. Once cancelled, PayPal stops generating and sending further invoices for the series. This action cannot be undone.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersrecurring_series_idrequired
delete_recurring_series
delete recurring series
Delete a recurring invoice series on PayPal.
This function permanently deletes a recurring invoice series by its ID. Only series in DRAFT status can be deleted -- for a series that has already been activated, use cancel_recurring_series instead. This action cannot be undone.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersrecurring_series_idrequired
list_invoices
list invoices
List invoices from PayPal.
This function retrieves a list of invoices with optional pagination parameters.
Parameterspagepage_sizetotal_required
Get an invoice from PayPal.
This function retrieves details of a specific invoice using its ID.
Parametersinvoice_idrequired
Send an invoice to the recipient(s).
This function sends a previously created invoice to its intended recipients.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersnoteinvoice_idrequiredsend_to_recipientadditional_recipients
send_invoice_reminder
send invoice reminder
Send a reminder for an invoice.
This function sends a reminder for an invoice that has already been sent but hasn't been paid yet.
Parametersnotesubjectinvoice_idrequiredadditional_recipients
cancel_sent_invoice
cancel sent invoice
Cancel a sent invoice.
This function cancels an invoice that has already been sent to the recipient(s).
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersnoteinvoice_idrequiredsend_to_recipientadditional_recipients
delete_invoice
delete invoice
Delete a draft or scheduled invoice on PayPal.
This function permanently deletes an invoice that is in the draft or scheduled state, by ID. It does not work on invoices that have already been sent -- use cancel_sent_invoice for those instead. After deletion, the invoice's details can no longer be retrieved, but its invoice number can be reused.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersinvoice_idrequired
setup_invoice_auto_reminders
setup invoice auto reminders
Initialize the invoice auto reminder configuration for the merchant's PayPal account.
This function sets up automatic reminders for unpaid invoices, for BEFORE_DUE and/or AFTER_DUE reminder types.
Parametersconfigurations
update_invoice_auto_reminder
update invoice auto reminder
Update an existing invoice auto reminder configuration by its configuration ID.
This function performs a full update of the reminder configuration's timing interval, repetition count and notification preferences.
Parameterstyperequiredstatusintervalrequiredrepetitionrequirednotificationreminder_configuration_idrequired
search_invoicing
search invoicing
Search for invoices or recurring invoice series on PayPal.
Use resource_type "invoice" with invoice_filters, or "recurring_series" with recurring_series_filters -- only set the matching filters object. Recurring series search covers only the past 3 years.
Parameterspagepage_sizeresource_typerequiredtotal_requiredinvoice_filtersrecurring_series_filters
update_invoicing
update invoicing
Update an existing invoice or recurring invoice series on PayPal.
For invoices, the recipient (primary_recipients) can only be changed 2 times within any 72-hour window -- avoid unnecessary recipient edits.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersresource_typerequiredinvoice_updaterecurring_series_update
cancel_invoice_auto_reminder
cancel invoice auto reminder
Cancel all scheduled automatic reminders for an invoice.
This function permanently cancels every automatic reminder scheduled for a specific invoice, by invoice ID. This action is irreversible -- once cancelled, automatic reminders cannot be re-enabled for that invoice.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersinvoice_idrequired
generate_invoice_qr_code
generate invoice qr code
Generate a QR code for an invoice.
This function generates a QR code for an invoice, which can be used to pay the invoice using a mobile device or scanning app.
Parameterswidthheightinvoice_idrequired
generate_invoice_number
generate invoice number
Generate the next invoice number available to the merchant.
This function generates the next invoice number by using the prefix and suffix from the merchant's last invoice number and incrementing the numeric portion by one (e.g. INVOICE-1234 -> INVOICE-1235).
Takes no parameters.
record_payment_for_invoice
record payment for invoice
Record a payment for an invoice on PayPal.
This function records an external or manual payment (for example, cash, check, bank transfer, or a PayPal transaction) against an invoice, by invoice ID. If the recorded amount covers the full amount due, PayPal marks the invoice PAID; otherwise it is marked PARTIALLY_PAID. This does not process a new payment -- it only logs one that was already collected.
method is required. payment_id applies only to PAYPAL-type payments.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersnoteamountmethodrequiredinvoice_idrequiredpayment_idpayment_dateshipping_infopayment_date_time
record_refund_for_invoice
record refund for invoice
Record a refund for an invoice on PayPal.
This function records a refund against an invoice, by invoice ID. If all payments made against the invoice are refunded, PayPal marks the invoice REFUNDED; otherwise it is marked PARTIALLY_REFUNDED. This does not process a new refund -- it only logs one that was already issued.
method is required.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersamountmethodrequiredinvoice_idrequiredrefund_date
create_conditional_rules_for_invoice
create conditional rules for invoice
Create conditional rules for an invoice on PayPal.
Parametersrulesrequiredinvoice_idrequired
create_product
create product
Create a product in PayPal using product catalog - create products API.
This function creates a new product that will be used in subscription plans, subscriptions.
Required parameters are: name (product name), type (product type).
High level:
- id: (auto-generated or specify SKU of the product) The ID of the product
- name: {product_name} (required)
- description: {product_description} (optional)
- type {DIGITAL | PHYSICAL | SERVICE} (required)
- category: {product_category} (optional)
- image_url: {image_url} (optional)
- home_url: {home_url} (optional)
Below is the payload request structure:
{
"id": "#PROD-XYAB12ABSB7868434",
"name": "Video Streaming Service",
"description": "Service for streaming latest series, movies etc.",
"type": "SERVICE",
"category": "SOFTWARE",
"image_url": "https://example.com/streaming.jpg",
"home_url": "https://example.com/home"
}
Parametersnamerequiredtyperequiredcategoryhome_urlimage_urldescription
list_products
list products
List products from PayPal.
This function retrieves a list of products with optional pagination parameters.
Parameterspagepage_sizetotal_required
update_product
update product
Update a product in PayPal.
This function updates an existing product using JSON Patch operations.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersoperationsrequiredproduct_idrequired
show_product_details
show product details
List products from PayPal.
This function retrieves a list of products with optional pagination parameters.
Parametersproduct_idrequired
create_subscription_plan
create subscription plan
Create a subsctiption plan in PayPal using subscription - create plan API.
This function creates a new subscription plan that defines pricing and billing cycle details for subscriptions.
Required parameters are: product_id (the ID of the product for which to create the plan), name (subscription plan name), billing_cycles (billing cycle details).
High level: product_id, name, description, taxes, status: {CREATED|INACTIVE|ACTIVE}, billing_cycles, payment_preferences are required in json object.
While creating billing_cycles object, trial(second) billing cycle should precede regular billing cycle.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersnamerequiredtaxesproduct_idrequireddescriptionbilling_cyclesrequiredpayment_preferences
list_subscription_plans
list subscription plans
List subscription plans from PayPal.
This function retrieves a list of subscription plans with optional product filtering and pagination parameters.
Parameterspagepage_sizeproduct_idtotal_required
show_subscription_plan_details
show subscription plan details
Show subscription plan details from PayPal.
This function retrieves the details of a specific subscription plan using its ID.
Required parameters are: plan_id (the ID of the subscription plan).
Parametersplan_idrequired
create_subscription
create subscription
Create a subscription in PayPal using the subscription - create subscription API.
This function allows you to create a new subscription for a specific plan, enabling the management of recurring payments.
The only required parameter is plan_id (the ID of the subscription plan). All other fields are optional and can be omitted if not provided.
The subscriber field is optional. If no subscriber information is provided, omit the subscriber field in the request payload.
The shipping address is optional. If no shipping address is provided, set the shipping_preference to GET_FROM_FILE in the application context.
The application context is also optional. If no application context information is provided, omit the application context field in the request payload.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parametersplan_idrequiredquantitysubscribershipping_amountapplication_context
show_subscription_details
show subscription details
Show subscription details from PayPal.
This function retrieves the details of a specific subscription using its ID.
Required parameters are: subscription_id (the ID of the subscription).
Parameterssubscription_idrequiredget_additional_details
cancel_subscription
cancel subscription
Cancel a customer subscription in PayPal.
This function cancels an active subscription for a customer. It requires the subscription ID and an optional reason for cancellation.
Required parameters are: subscription_id (the ID of the subscription to be canceled).
Below is the payload request structure:
{
"reason": "Customer requested cancellation"
}
You MUST ask the user for:
- subscription_id
- reason for cancellation.
Return all of the above as structured JSON in your response.
Checked by fizzl-paypal-guard before it runs: within the owner's limits; above them the owner approves or denies.
Parameterspayloadrequiredsubscription_idrequired
update_subscription
update subscription
Update a customer subscription in PayPal.
This function updates an active or suspended subscription for a customer. It requires the subscription ID and payload of allowed keys to update to the subscription.
Required parameters are: subscription_id (the ID of the subscription to be updated), and at-least one key to update
Return response as structured JSON in your response.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parameterscustom_idfixed_pricecurrency_codeshipping_amountsubscription_idrequiredtaxes_inclusiveshipping_addresstaxes_percentageoutstanding_balanceauto_bill_outstandingpayment_failure_threshold
create_shipment_tracking
create shipment tracking
Create a shipment for a transaction in PayPal.
This function creates a shipment record for a specific transaction, allowing you to track the shipment status and details.
The transaction_id can fetch from the captured payment details in the order information.
Required parameters are: tracking_number (the tracking number for the shipment), transaction_id (the transaction ID associated with the shipment).
High level: tracking_number, transaction_id, status (optional), carrier (optional) are required json objects.
Below is the payload request structure:
{
"tracking_number": "1234567890",
"transaction_id": "9XJ12345ABC67890",
"status": "SHIPPED", // Required: ON_HOLD, SHIPPED, DELIVERED, CANCELLED
"carrier": "UPS" // Required: The carrier handling the shipment. Link to supported carriers: http://developer.paypal.com/docs/tracking/reference/carriers/
}
Parametersstatuscarrierorder_idtransaction_idrequiredtracking_numberrequired
get_shipment_tracking
get shipment tracking
Get tracking information for a shipment by ID.
This function retrieves tracking information for a specific shipment using the transaction ID and tracking number.
The transaction_id can fetch from the captured payment details in the order information.
Below is the payload request structure:
Parametersorder_idtransaction_id
update_shipment_tracking
update shipment tracking
Update tracking information for a shipment by ID and status.
This tool updates tracking information such as the carrier or the tracking number for a specific shipment using the transaction ID and status.
Parametersstatusrequiredcarriertransaction_idrequiredtracking_numberrequirednew_tracking_number
Create an order in PayPal.
This tool is used to create a new order in PayPal. This is typically the first step in initiating a payment flow. It sets up an order with specified details such as item(s) to be purchased, quantity, amount, currency, and other details.
ParametersitemsrequirednotesdiscountcancelUrlreturnUrlcurrencyCoderequiredshippingCostshippingAddress
Retrieves the order details from PayPal for a given order ID.
This tool is used to retrieve details of an existing order in PayPal. It provides information about the order, including items, amounts, status, and other relevant details.
Parametersidrequired
Capture a payment for an order.
This tool is used to capture a payment for an order. It allows you to capture funds that have been authorized for a specific order but not yet captured.
Parametersidrequired
list_disputes
list disputes
List disputes from PayPal.
This function retrieves a list of disputes with optional pagination and filtering parameters.
Parameterspagepage_sizedispute_statedisputed_transaction_id
Get details for a specific dispute from PayPal.
This tool is used to lists disputes with a summary set of details, which shows the dispute_id, reason, status, dispute_state, dispute_life_cycle_stage, dispute_channel, dispute_amount, create_time and update_time fields.
Parametersdispute_idrequired
accept_dispute_claim
accept dispute claim
Accept liability for a dispute claim.
This tool is used to accept liability for a dispute claim. When you accept liability for a dispute claim, the dispute closes in the customer's favor and PayPal automatically refunds money to the customer from the merchant's account.
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersnoterequireddispute_idrequired
list_transactions
list transactions
List transactions from PayPal.
This tool is used to list transactions with optional filtering parameters within a date range of 31 days. This tool can also be used to list details of a transaction given the transaction ID.
- The start_date and end_date should be specified in ISO8601 date and time format. Example dates: 1996-12-19T16:39:57-08:00, 1985-04-12T23:20:50.52Z, 1990-12-31T23:59:60Z
- The transaction_status accepts the following 4 values:
1. "D" - represents denied transactions.
2. "P" - represents pending transactions.
3. "S" - represents successful transactions.
4. "V" - represents transactions that were reversed.
- The transaction_id is the unique identifier for the transaction.
Parameterspageend_datepage_sizestart_datesearch_monthstransaction_idtransaction_status
Update a billing plan in PayPal using the Plans API (PATCH).
This function updates an existing plan with status CREATED or ACTIVE. For INACTIVE plans, only status updates are allowed.
You can patch the following attributes and objects in one call:
- name
- description
- payment_preferences.auto_bill_outstanding
- payment_preferences.payment_failure_threshold
- payment_preferences.setup_fee
- payment_preferences.setup_fee_failure_action
- taxes.percentage
Checked by fizzl-paypal-guard before it runs: the owner approves or denies each one.
Parametersnameplan_idrequiredsetup_feeoperationsrequiredpercentagedescriptionauto_bill_outstandingsetup_fee_failure_actionpayment_failure_threshold
create_refund
create refund
Initiate a refund for a PayPal payment capture.
If you have an order ID instead of a capture ID, first use the get order tool to obtain the capture ID from the order details.
This function allows you to return funds to a customer by refunding a previously captured payment. You can issue a full refund or specify a partial amount. If multiple captures exist for an order, request clarification on which specific capture to refund.
Required parameters:
- Capture ID: The ID of the capture to refund
- Amount (optional): For partial refunds, specify the amount to refund (must be less than or equal to the captured amount)
- Note to Payer (optional): Additional explanation visible to the customer
Response details include:
- Refund ID and status
- Refunded amount and currency
Checked by fizzl-paypal-guard before it runs: never more than is left of the payment, within the owner's limits; above them the owner approves or denies.
Parametersamountcapture_idrequiredinvoice_idnote_to_payer
Retrieve detailed information about a PayPal payment refund.
If you have an order ID instead of a refund ID, first use the get order tool to obtain the refund ID from the order details.
This function returns comprehensive details about a refund, including its current status (completed, pending, cancelled), refunded amount, and processing information.
When multiple refunds exist for an order or capture, request clarification on which specific refund to retrieve.
Response details include:
- Refund status and ID
- Refunded amount and currency
- Reason for refund (if provided)
- Source transaction details
Parametersrefund_idrequired
get_merchant_insights
get merchant insights
Retrieve business intelligence metrics and analytics for a merchant, filtered by start date, end date, insight type, and time interval.
This tool returns actionable insights into orders and sales data, supporting data-driven business decisions.
Parametersend_daterequiredstart_daterequiredinsight_typerequiredtime_intervalrequired
paypal_guard_status
PayPal guard: status
What fizzl-paypal-guard allows and has done: the owner's limits, how much of today's limits is used, approvals waiting for the owner, and the latest decisions (from a log the agent doesn't write). With approval_id: what became of that one approval.
Parametersapproval_id
paypal_guard_check
PayPal guard: dry run
Dry run: what fizzl-paypal-guard would decide for a PayPal tool call (allow, ask the owner, or deny, and why), without running it, counting it or asking anyone. Reads the payment, invoice or dispute at PayPal.
Parameterstoolrequiredarguments