Reference

List Balance Lines

Retrieve all one-time charges and credits applied to a customer or subscription to track adjustments and account activity. This helps you understand what additional fees or refunds have been applied beyond regular billing.

Quote Balance Line Creation

Get an instant pricing quote for a one-time charge or credit to apply to a customer's account, including all applicable taxes before confirming the transaction.

List Business Localization

Retrieve customizable text and content settings for your hosted payment pages, with options to filter by language or content type. Use this to manage how your payment pages appear to customers in different languages and regions.

List Businesses

Retrieve a list of all your businesses from ProAbono, with optional filtering by state or update date to find specific business records.

List Segment Localizations

Retrieve translated content and localization settings for customer-facing pages by segment, allowing you to customize how payment and billing information appears in different languages and regions.

List Segments

Retrieve all customer segments from ProAbono to view how your subscribers are organized by pricing tiers, features, or other groupings. Use this to understand your current subscription structure and segment-specific configurations.

Update Business Billing Address

Modify your business billing information such as company name, address, and tax details to keep your subscription records accurate and up-to-date.

Create Customer

Register a new customer in your ProAbono account to enable billing and subscription management for their account. This operation sets up the foundation for tracking payments and managing customer subscriptions.

Get Customer by ID

Retrieve detailed information about a specific customer including their billing details, account status, and subscription information from your payment system.

List Customers

Retrieve all your customers from ProAbono with optional filtering by business, state, language, or creation date to access their details and current status. Use this to get a complete view of your customer base or find specific customers matching your criteria.

Update Customer

Modify existing customer information in ProAbono such as name, email, language preferences, or other account details without needing to recreate the customer record.

Anonymize Customer

Permanently removes personal data from a customer record to comply with data privacy regulations, while preserving their account history and transaction records for legal and accounting purposes.

Delete Customer

Remove a customer record from your ProAbono billing system when they no longer need service or request account deletion. This permanently deletes their associated data from your subscription management system.

Get Customer Billing Address

Retrieve a customer's complete billing address and tax information stored in your payment system. Use this to access company details, contact information, and address lines whenever you need to verify or reference customer billing data.

Get Customer Billing Address by Reference

Retrieve a customer's billing address and tax information from your ProAbono account using their reference identifier, useful for order fulfillment, invoicing, and compliance verification.

Get Customer by Reference

Retrieve detailed customer information by using your own reference identifier, allowing you to quickly access subscription and payment data without needing ProAbono's internal ID.

Get Customer Payment Settings

Retrieve a customer's payment configuration and billing details to understand their current payment method and schedule. Use this to verify payment setup before taking billing actions or troubleshooting payment issues.

Invalidate Customer

Revoke a customer's access to their subscribed services while preserving their account history and data for future reference. This prevents them from using your service without deleting their account information.

Invalidate Customer by ID

Deactivate a customer account in ProAbono and reset their reference ID to free up that identifier for other uses, while automatically regenerating their secure portal access links.

List Customers by Feature

Retrieve all customers who have access to a specific feature in their subscription plan, helping you understand feature adoption and usage patterns across your customer base.

Revoke Customer Portal Links

Invalidate previously generated customer portal access links and create new ones to maintain security and prevent unauthorized access to customer accounts.

Update Customer Billing Address

Modify a customer's billing address in ProAbono to ensure invoices are sent to the correct location with accurate company and tax information. This keeps your billing records current when customers move, change office locations, or update their legal entity details.

Update Customer Payment Settings

Modify a customer's payment method preferences and billing configuration to ensure payments are processed smoothly and according to their needs. This lets you update how and when customers are charged for their subscriptions or recurring services.

Update Customer Shipping Address

Modify a customer's shipping address and related information like company name, contact details, and tax ID. Use this when customer location details change or need correction in your subscription management system.

Delete Subscription Discount

Remove a discount that was previously applied to a customer's subscription, allowing you to adjust pricing or end promotional offers.

Get Discount

Retrieve detailed information about a specific discount including its amount, type, and current status to verify discount details before applying them to customer accounts.

List Discounts

Retrieve all available discounts in your billing system, with options to filter by status (Enabled or Draft). Use this to review your pricing strategies and understand which discounts are currently active or in planning.

List Subscription Discounts

Retrieve all discounts currently applied to your subscriptions, helping you track promotional offers and their impact on your recurring revenue.

Create Feature

Define new features or capabilities for your subscription plans, such as usage limits or toggleable functionalities that customers can access based on their subscription tier.

Get Feature by ID

Retrieve detailed information about a specific feature in your subscription system, including its name, description, and settings. Use this when you need to verify feature details or understand what capabilities are included in your offerings.

List Features

Retrieve all features from your ProAbono billing system with optional filtering by business, lifecycle state, visibility, or creation date. Use this to see what feature offerings you have configured across your subscription plans.

List Subscription Features

Retrieve all available subscription features from your Proabono account to understand what features are included in your subscription tiers. This helps you manage and organize your product offerings and feature sets.

Update Feature

Modify an existing feature in your ProAbono subscription product, allowing you to adjust its name, visibility settings, type, or display order without recreating it.

Bill Customer

Creates invoices for a customer's pending charges, allowing you to manually trigger billing outside of your regular billing cycle. This is useful when you need to bill immediately for additional services or adjust charges for a specific customer.

List Invoices and Credit Notes

Retrieve all invoices and credit notes from your ProAbono account with optional filtering by business, payment status, or date range to track your billing history and financial records.

Get Invoice

Retrieve detailed information about a specific invoice or credit note from your ProAbono account using its ID. Use this to access invoice details, payment status, and financial records whenever you need to verify or reconcile billing information.

List Invoice Lines

Retrieve detailed line items from your invoices in ProAbono, with options to filter by business, specific invoice, or minimum amount. Use this to analyze what you're billing customers for and review itemized invoice details.

List Invoices by Customer Reference

Retrieve all invoices associated with a specific customer using their unique identifier, helping you quickly access a customer's billing history and payment records.

Delete Offer

Permanently remove an offer from your ProAbono subscription system, completely deleting it so customers can no longer see or access it.

Delete Pricing Table Offer

Remove a pricing table offer from your billing system when it's no longer needed or needs to be replaced with a new offering. This helps keep your pricing structure clean and prevents customers from seeing outdated options.

Get Offer by ID

Retrieve detailed information about a specific offer to view pricing, features, and terms associated with that offer.

List Offers

Retrieve all available subscription offers or plans from your ProAbono account, with optional filtering by business, state, visibility, or update date. This helps you view and manage your pricing tiers and subscription options.

List Pricing Table Offers

Retrieve all offers configured in your pricing tables to understand your current subscription packages and their features. This helps you manage and review what you're offering to customers.

List Upgrade Offers

Retrieve available upgrade options for a customer's existing subscription to help them explore higher-tier plans or additional features. This enables you to present relevant upgrade paths based on their current plan.

List Payments

Retrieve all payments processed through your ProAbono account with optional filtering by business, customer, or update date to track transaction history and revenue.

List Gateway Accounts

Retrieve all your payment gateway accounts configured in ProAbono with optional filters by business, currency, or account status. Use this to see which payment processors you have set up and their current configuration details.

List Gateway Permissions

Retrieve all payment gateway permissions configured in your ProAbono account, optionally filtered by business, customer, or creation date to see which payment methods and gateways are authorized.

List Gateway Requests

Retrieve a paginated list of payment gateway requests from ProAbono with optional filtering by account, permission, transaction, dates, or status to track payment processing history and troubleshoot transaction issues.

List Gateway Transactions

Retrieve all payment gateway transactions from your ProAbono account with optional filtering by business, customer, or date to track and analyze payment activities.

Delete Pricing Table

Removes a pricing table from your ProAbono account by its ID, allowing you to clean up outdated or unused pricing structures.

List Pricing Tables

Retrieve all pricing tables from your ProAbono account to view available subscription plans and pricing structures. Use this to see what pricing options you've set up and manage them effectively.

List Subscriptions

Retrieve all your active and inactive subscriptions from ProAbono to monitor customer billing status, track recurring revenue, and manage subscription lifecycles.

Get Subscription by Customer Reference

Retrieves detailed subscription information for a specific customer using their reference identifier, allowing you to quickly access current subscription status and details without searching through multiple records.

Get Subscription Creation Quote

Calculates and displays the exact cost of a new subscription before you commit to creating it, helping you verify pricing and avoid unexpected charges.

List Customer Moves

Retrieve a complete history of balance transactions, credits, debits, and billing movements for your customers. This helps you track account activity, monitor payment flows, and reconcile customer accounts with detailed transaction records.

List Subscription Periods

Retrieve all billing cycles for your subscriptions, with options to filter by specific business, subscription, or date range. Use this to monitor your recurring billing schedule and manage subscription periods across your business.

List Tax Profile Exceptions

Retrieve all tax profile exceptions configured in your ProAbono account, with optional filtering by business, tax profile, country, or region to find specific tax rule overrides.

List Tax Profiles

Retrieve all your tax profiles and configurations from ProAbono, with optional filtering by business ID, to manage tax rates and settings across your subscriptions.

Update Tax Profiles

Modify existing tax profiles in your billing system to keep tax rates, names, and descriptions current with your business needs and regional regulations.

Get Usage Record

Retrieve usage data for a specific customer's feature to monitor their current consumption, quota status, or feature access. Helps you verify what your customer has used and what's still available under their plan.

Get Usages for Customer

Retrieve detailed feature usage data for a customer to track how they're using your subscription's features, including on/off toggles, usage limits, and consumption metrics.

Enable Webhook

Activates a webhook endpoint in ProAbono to start receiving real-time payment and subscription event notifications. Use this when you need to resume monitoring critical account activities after disabling a webhook.

List Webhook Notifications

Retrieve your webhook notification history from ProAbono to monitor payment events and subscription changes that have been sent to your systems, with options to filter by date range, status, or specific webhooks.

List Webhooks

Retrieve all configured webhooks from your ProAbono account to see which events are being monitored and where notifications are being sent. This helps you understand your current notification setup and verify that important business events are properly tracked.