Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Invoice

Create and manage PayPal invoices directly from Discord.

Overview

The Invoice addon lets your staff create PayPal invoices directly from Discord, share payment links or QR codes, and track payment status without leaving the server. It supports optional partial payments, fee handling, and webhook-driven status updates.

Table of Contents

  1. Features

  2. Installation

  3. How It Works

  4. Commands

  5. Webhooks and Logs

Features

Invoice Creation

  • Create PayPal invoices from Discord: Use a slash command to generate invoices with item, price, and customer details

  • Pay link and QR code: Share a direct PayPal pay link and optional QR code

  • Fee handling: Automatically add a percentage fee to invoice totals

  • Optional partial payments: Allow partial payments with an enforced minimum

Status Tracking

  • Live status sync: Refresh invoice status from PayPal on demand

  • Paid/partial/ cancelled states: Track payment progress and close out invoices automatically

  • Webhook updates: Auto-update invoice status when PayPal sends events

Logging and Visibility

  • Dedicated logs channel: Log invoice events in a configured Discord channel

  • Audit-friendly embeds: Consistent log entries for created, paid, cancelled, and refunded invoices

Installation

This is a premium addon! You must purchase this addon separately and have a valid license.

  1. Download the Invoice addon files from your purchase

  2. Extract all files into the plugins/ folder of your Athena Bot installation

  3. Restart your bot to load the addon

  4. Configure the addon using the invoice.json5 file in your configuration/ folder

How It Works

1. Configure PayPal

Add your PayPal REST API client ID and secret, then choose sandbox or live mode. A PayPal Business account is required to create live API credentials. Optional: enable webhooks for automatic status updates.

2. Create an Invoice

Use /invoice create to generate a PayPal invoice. The bot posts an embed with buttons for:

  • Pay link (opens PayPal)

  • QR code (for mobile payments)

  • Resync (manual status refresh)

  • Cancel (close the invoice)

3. Track Status

Invoices are stored and can be viewed with /invoice view. Status changes are synced via PayPal API or webhooks.

Commands

Staff Commands

/invoice create

  • Create a new invoice

  • Options: customer (user), price (1-5000), item (text), email (optional)

/invoice view

  • View a previously created invoice

  • Options: id (invoice ID)

/invoice cancel

  • Cancel an existing invoice

  • Options: id (invoice ID)

Webhooks and Logs

PayPal Webhooks

If you enable webhooks, configure PayPal to send events to:

Recommended events:

  • INVOICING.INVOICE.CREATED

  • INVOICING.INVOICE.PAID

  • INVOICING.INVOICE.PARTIALLY_PAID

  • INVOICING.INVOICE.CANCELLED

  • INVOICING.INVOICE.REFUNDED

Discord Logs

When enabled, the addon logs invoice activity in the paypal_invoice_logs channel.

Last updated