API Billings¶

Feature Overview¶

The Yappes API Billing feature provides a comprehensive invoicing and payment management system designed to streamline financial transactions between API providers and consumers on the platform.

This powerful feature allows API providers to effortlessly create, manage, and track invoices for their API partners, while enabling consumers to conveniently view, review, and pay for their API usage.

Yappes API Billing allows you to manage the complete billing lifecycle so you can maintain transparent financial relationships with your API partners. For providers, this means gaining complete visibility into payment statuses, managing billing information, and generating professional invoices with just a few clicks.

For consumers, it offers a seamless experience to review detailed subscription charges, download PDF invoices for records, and make secure payments directly through the platform.

This feature integrates seamlessly into your existing Yappes workflows, eliminating the need for external billing systems and reducing administrative overhead. Whether you're a provider managing multiple API partners or a consumer tracking your API expenses, the API Billing feature ensures accurate, timely, and transparent billing processes that support your business operations.

Prerequisites¶

Before you begin, ensure you have the following ready to successfully use the API Billing feature.

Required Access and Permissions¶

Valid Yappes Enterprise account with appropriate credentials
API Provider role for invoice creation and management functions
API Consumer role for viewing invoices
Active API subscriptions (for consumers) or API partners (for providers)

System Requirements¶

Modern web browser with PDF viewing capability
Access to the Yappes Enterprise platform

Step-by-Step Implementation¶

Part 1: Accessing the API Billing System¶

Step 1: Navigate to API Billings¶

From the dashboard, locate and click the relevant navigation icon
Click API Billings from the menu
The API Billings section will load

Part 2: Provider View - Managing Invoices¶

Step 2: Access the Provider View¶

Within the API Billings section, click Provider View
The invoice management interface will display

Step 3: Create a New Invoice¶

Click the Create Invoice button
The invoice creation form will appear

Step 4: Configure Invoice Details¶

Click the Org dropdown field
Select the target organization from the list
Click the Month dropdown field
Select the billing month

Step 5: Generate the Invoice¶

Review your selections
Click the Generate Invoice button
Wait for the system to process the invoice

Part 3: Regenerating Existing Invoices¶

Step 6: Regenerate an Invoice¶

Note

Use this feature when you need to update or correct an existing invoice.
During regeneration, the Organization and Month fields will be disabled.
The invoice will be regenerated based only on the previously generated invoice.

From the Provider View, locate the Regenerate Invoice option
Click the Regenerate Invoice button

Info

After regeneration, you can download the updated invoice in PDF format.

Part 4: Managing Billing Addresses¶

Step 7: Update Billing Address Information¶

In the Provider View, navigate to the Billing Address section
Click the Edit button to modify details
Update the following required fields:
- Company Name
- GST Number
- Address
- City
- State
- Pin code
- Country
- Contact Number
Save your changes

Part 5: Consumer View - Viewing and Paying Invoices¶

Step 8: Access Consumer Invoice View¶

Navigate to the Consumer View section
Your invoice list will display automatically

Expected Result: You see a table of your invoices with payment options

Step 9: Review Invoice Details¶

Click on an invoice to view it in PDF format
Review your subscriptions and associated charges
Verify all details are correct

Understanding the Interface¶

Provider View Components¶

The Provider View interface consists of several key areas that help you manage billing efficiently:

Invoice Management Table: Displays comprehensive invoice information including Invoice ID, billing month, due date, payment status, and amount
Key Interface Elements:
- Create Invoice Button: Initiates new invoice generation
- Regenerate Invoice Option: Updates existing invoices
- Billing Address Section: Manages company billing information

Consumer View Components¶

The Consumer View provides a streamlined interface for payment management.

Primary Elements:
- Invoice List: Comprehensive view of all your invoices
- PDF Viewer: Integrated document viewer for invoice details
- Subscription Details: Clear breakdown of charges and services

Configuration and Settings¶

Essential Configuration Options¶

For Providers¶

Setting	Purpose	When to Use
Organization Selection	Identifies the API partner for billing	Required for every invoice
Billing Month	Specifies the service period	Set for each billing cycle
Billing Address	Legal entity information	Update when company details change

For Consumers¶

Feature	Function	Best Practice
Invoice View Dialog	Opens invoice details in a dialog for accurate review	Always confirm the dialog opens and details are correct
Subscription Review	Verify charges accuracy	Review every month

Verification and Testing¶

Confirming Successful Invoice Creation¶

For Providers¶

After generating an invoice, verify it appears in your invoice table
Check that all details (ID, Month, Due Date, Amount) are correct
Ensure the invoice is visible to the respective consumer

For Consumers¶

Verify you can view the invoice
Confirm all subscription details and charges are accurate

Troubleshooting¶

Common Issues and Solutions¶

Issue: Invoice Generation Fails
Solution: Ensure all required fields (Organization and Month) are selected. Verify you have proper provider permissions.
Issue: Cannot View Invoice PDF
Solution: Check browser PDF plugin settings. Try downloading the invoice directly or use a different browser.
Issue: Billing Address Won't Update
Solution: Confirm all required fields are completed: Company Name, GST Number, Address, City, State, Pin code, Country, and Contact Number.

Pro Tip

Regular monitoring of invoice statuses and timely payment processing ensures uninterrupted API services and maintains positive partner relationships on the Yappes platform.