Skip to main content
Proabono logo
  • Category: ecommerce
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 64
  • Triggers: 0
  • Slug: PROABONO
  • Version: 20261101_00

Tools

Slug: PROABONO_ANONYMIZE_CUSTOMERTool to anonymize a customer for GDPR compliance. Use when you need to permanently remove personal data from a customer record while maintaining the account structure. The customer must have no active subscriptions, all invoices must be settled, and the balance must be empty before anonymization.

Input Parameters

string
required
The unique reference of the customer to anonymize. This is your application’s customer reference identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_BILL_CUSTOMERBills a customer’s balance using the customer reference, normally creating an invoice for all available balance lines. Use this to trigger billing for a customer’s pending charges.

Input Parameters

string
required
The unique reference of the customer to bill. This identifier is used to trigger billing and create invoices for pending charges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_CREATE_CUSTOMERTool to create or declare a customer in ProAbono via the Backoffice API. Use when you need to register a new customer with billing and subscription management capabilities.

Input Parameters

string
Display Name of your customer
string
required
Email of your customer
string
Language of your customer. By Default, ProAbono will use the language of the segment
object
Custom key-value metadata for the customer (max 5 pairs, 50-char keys, 450-char values)
integer
required
Id of your Business
string
Reference of the segment in which the customer will be created. Required only if you have more than 1 segment
string
Reference of your customer shared with your application and ProAbono. Use your own id/reference user
string
Reference of the affiliate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_CREATE_FEATURETool to create a new feature in ProAbono via the Backoffice API. Features define capabilities or usage limits that can be attached to offers. Use when you need to define a new feature (OnOff, Limitation, or Consumption type) for your subscription plans.

Input Parameters

string
required
The feature name displayed to users
integer
Display position among other features (lower numbers appear first)
boolean
Whether to show this feature in offers and hosted pages
integer
required
Your Business identifier
string ("OnOff" | "Limitation" | "Consumption")
required
Feature type: OnOff (boolean feature), Limitation (quota/limit), or Consumption (metered usage)
string
Shared key between ProAbono and your system for identifying this feature

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_DELETE_CUSTOMERTool to delete a customer from ProAbono by ID. Use when you need to remove a customer record from the system.

Input Parameters

integer
required
ID of the customer to delete. This is the unique customer identifier in ProAbono.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_DELETE_OFFERTool to delete an offer from ProAbono by ID. Use when you need to permanently remove an offer from the system.

Input Parameters

integer
required
The unique ID of the offer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_DELETE_PRICING_TABLETool to delete a pricing table from ProAbono by its ID. Use when you need to remove a pricing table from the system.

Input Parameters

integer
required
The unique ID of the pricing table to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_DELETE_PRICING_TABLE_OFFERTool to delete a pricing table offer via the ProAbono Backoffice API. Use when you need to remove an existing pricing table offer by its ID.

Input Parameters

integer
required
The unique identifier of the pricing table offer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_DELETE_SUBSCRIPTION_DISCOUNTDelete a subscription discount by its ID via the ProAbono Backoffice API. The tool reports success for a 404 response as well as for successful deletion.

Input Parameters

integer
required
The subscription discount ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_ENABLE_WEBHOOKTool to enable a webhook in ProAbono via the Notification API. Use when you need to activate a previously disabled webhook for receiving event notifications.

Input Parameters

integer
required
The unique identifier of the webhook to enable. Must be a valid webhook ID from your ProAbono account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_CUSTOMERRequests a single customer by ID using the ProAbono Live API. The response model includes customer status and related links.

Input Parameters

integer
required
The unique identifier of the customer to retrieve
integer
The business identifier. Optional parameter to scope the request to a specific business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_CUSTOMER_BILLINGTool to retrieve a customer’s billing address via the Backoffice API. Use when you need to fetch billing information including company name, contact details, address lines, and tax information for a specific customer.

Input Parameters

integer
required
The customer ID whose billing address to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_CUSTOMER_BILLING_ADDRESSTool to retrieve the billing address for a customer by reference from ProAbono API. Use when you need to fetch billing address details including company, contact information, address lines, and tax information using the customer’s reference identifier.

Input Parameters

string
required
The unique reference of the customer to retrieve billing address for. This is the shared identifier between ProAbono and your application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_CUSTOMER_BY_REFERENCETool to retrieve a customer by their reference identifier from ProAbono API. Use when you need to fetch customer details using the unique reference identifier from your own application rather than the ProAbono internal ID.

Input Parameters

string
required
The unique reference identifier of the customer to retrieve, used within your own application

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_CUSTOMER_PAYMENT_SETTINGSRetrieves a customer’s payment settings by customer reference through the ProAbono Live API, including payment method type and next billing date.

Input Parameters

string
required
The unique reference identifier of the customer whose payment settings to retrieve (ReferenceCustomer property)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_DISCOUNTRetrieve a specific discount by ID and business ID from the ProAbono Backoffice API. The returned discount can include its value, type, target fees, and state.

Input Parameters

integer
required
The discount ID to retrieve
integer
required
Your business ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_FEATURERetrieve a ProAbono feature by ID to inspect its details, such as its name, type, visibility, and lifecycle state. An optional business identifier can be supplied to scope the request.

Input Parameters

integer
required
ID of the feature to retrieve
integer
Optional business identifier filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_INVOICETool to retrieve a specific invoice or credit note by ID from ProAbono. Use when you need to fetch detailed information about an invoice.

Input Parameters

integer
required
The unique identifier of the invoice or credit note to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_OFFERRequest details of a single ProAbono offer using an offer ID and business ID. Use this to look up an offer and its pricing and related information.

Input Parameters

integer
required
The unique identifier of the offer to retrieve
integer
required
The business identifier. Required to scope the request to a specific business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_SUBSCRIPTION_BY_CUSTOMERRetrieve a customer’s active subscription by customer reference. If the customer has multiple active subscriptions, the API returns only the last one; a no-content response is reported as an error.

Input Parameters

integer
The business identifier. Optional parameter to scope the request to a specific business
string
required
The unique reference of the customer to retrieve their subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_SUBSCRIPTION_CREATION_QUOTETool to get a pricing quote for creating a new subscription without actually creating it. Use when you need to calculate the cost of a subscription before committing to its creation.

Input Parameters

string
required
The reference of the offer to quote for subscription creation
string
required
The unique reference of the customer for whom the subscription quote is being generated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_USAGETool to retrieve a single usage record for a specific feature and customer combination from ProAbono. Use when you need to check current usage status, remaining quota, or feature availability for a customer. The response varies based on feature type: OnOff features return IsIncluded/IsEnabled, while Limitation and Consumption features return quantity information.

Input Parameters

string
required
The reference of the feature to retrieve usage for. This is the shared key between ProAbono and your application.
string
required
The unique reference of the customer to retrieve usage for. This is the identifier from your application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_GET_USAGES_FOR_CUSTOMERTool to retrieve usage data for customers from ProAbono. Use when you need to fetch feature usage information including OnOff, Limitation, and Consumption features. Parameters can be combined to filter results by customer reference, customer ID, or subscription ID.

Input Parameters

integer
Retrieve usages exclusively from a specific customer by ID
integer
Retrieve usages exclusively from a specific subscription by ID
string
Reference of the customer - retrieve usages exclusively from this customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_INVALIDATE_CUSTOMERInvalidate a customer by reference, replacing the customer reference so it can be reused and revoking existing portal links. Active subscriptions are not terminated.

Input Parameters

string
required
The unique reference of the customer to invalidate. This is your application’s customer reference identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_INVALIDATE_CUSTOMER_BY_IDTool to invalidate a customer by their ProAbono internal ID. Use when you need to free up a customer reference for reuse. This operation replaces the customer’s ReferenceCustomer with a new value and regenerates all encrypted portal links.

Input Parameters

integer
required
The ProAbono internal ID of the customer to invalidate. This operation replaces the customer’s reference identifier with a new value, allowing the original reference to be reused for a different customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_BALANCE_LINESList ProAbono balance lines for a customer reference or subscription ID, with pagination. Balance lines include charges and credits; a customer reference or subscription ID is required. An empty result is returned when no lines are found or the requested customer or subscription is not found.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
boolean
Flag to retrieve the outstanding balances of the upcoming billing. Set to true to get only balance lines that will be included in the next billing.
integer
The ID of the subscription to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.
string
The reference of the customer to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_BUSINESSESTool to list all businesses from ProAbono via the Backoffice API. Use when you need to retrieve business information with optional filtering by state or update date.

Input Parameters

integer
Page number. Default: 1.
string
Filter businesses by lifecycle state. Common values include ‘Ok’ for active businesses.
integer
Number of items per page. Default: 10, max: 1000.
string
Filter businesses updated after this date. Must be in ISO 8601 format (e.g., ‘2023-04-27T06:54:00’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_BUSINESS_LOCALIZATIONTool to list localization entries by business from ProAbono via the HostedPages API. Use when you need to retrieve customizable text, HTML, or URL content for hosted pages with optional filtering by language, customization status, content, or code keywords. Returns paginated results with localization details.

Input Parameters

string
Filter localizations by code keyword. Returns localizations containing the specified text in their code field.
integer
Page number. Default: 1.
string
Filter localizations by content keyword. Returns localizations containing the specified text in their content field.
boolean
Filter for custom localizations. Set to true to retrieve only customized localizations, false for standard localizations.
string
Filter localizations by language code (ISO 639-1 format, e.g., ‘en’, ‘fr’). Returns only localizations matching this language.
integer
Number of items per page. Default: 10, max: 1000.
integer
required
ID of the business to retrieve localizations for. This is a required parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_CUSTOMER_MOVESLists customer balance moves through the ProAbono Backoffice API, with pagination and filters for customer, unbilled status and minimum update date.

Input Parameters

integer
Page number for paginated results. Defaults to 1 if not specified.
boolean
Whether to include total count in the response. Defaults to true.
Whether to generate HATEOAS links in the response. Defaults to true.
integer
Number of items per page. Maximum is 1000.
integer
required
Your business ID. This is required to identify which business to query.
integer
Customer identifier to filter moves for a specific customer
boolean
Filter to show only unbilled moves (true) or all moves (false/null)
string
Filter moves updated after this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_CUSTOMERSTool to list all customers from ProAbono via the Backoffice API. Use when you need to retrieve customer information with optional filtering by business, state, language, or creation date. Returns paginated results with customer details including ID, name, email, and status.

Input Parameters

integer
Page number. Default: 1.
string
Filter by language code (ISO 639-1 format, e.g., ‘EN’, ‘FR’)
string
Filter by state life status of the customer (e.g., ‘Ok’)
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to retrieve customers for a specific business
string
Minimum creation date filter in ISO 8601 format (e.g., ‘2025-07-27T13:54:00’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_CUSTOMERS_BY_FEATUREList customers with active subscriptions containing a specified feature, with feature usage and billing-period details. An empty result can also indicate an inaccessible feature or segment.

Input Parameters

integer
Page number for pagination (starts at 1)
integer
Number of results per page (default and maximum values are API-defined)
string
required
Reference of the Feature to filter customers having active subscriptions containing that specific feature
string
Limit results to customers in a specific segment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_DISCOUNTSTool to list all discounts from ProAbono’s Backoffice API. Use when you need to retrieve discounts for a business, optionally filtering by state (Enabled/Draft).

Input Parameters

integer
Page number to retrieve (1-based). Defaults to 1 if not specified.
integer
Number of items per page. Controls how many discounts are returned per request.
integer
Filter by Business ID to retrieve discounts for a specific business
string
Filter by discount state. Use ‘Enabled’ for active discounts or ‘Draft’ for inactive ones

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_FEATURESTool to list all features via the ProAbono Backoffice API. Use when you need to retrieve features with optional filtering by business ID, lifecycle state, visibility, or creation date. Returns a paginated collection of feature objects.

Input Parameters

boolean
Filter by visibility status - true to show only visible features, false for hidden features
string
Filter by feature lifecycle state (e.g., ‘Ok’)
integer
Filter by Business ID to list features for a specific business
string
Minimum creation date filter in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_GATEWAY_ACCOUNTSTool to list payment gateway accounts from ProAbono Backoffice API. Use when you need to retrieve gateway account information with optional filtering by business, currency, real money mode, or creation date. Returns paginated results with account details including ID, name, type, and state.

Input Parameters

integer
Page number. Default: 1.
string
Filter by currency code in ISO 4217 format (e.g., ‘USD’, ‘EUR’)
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to retrieve gateway accounts for a specific business
boolean
Filter by real money mode. Set to true for live accounts, false for test accounts.
string
Minimum creation date filter in ISO 8601 format (e.g., ‘2023-07-27T13:54:00’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_GATEWAY_PERMISSIONSTool to list gateway permissions from ProAbono API. Use when you need to retrieve payment permissions with optional filtering by business, customer, or creation date.

Input Parameters

integer
Filter by Business ID. Use to retrieve permissions for a specific business entity.
integer
Filter by Customer ID. Use to retrieve permissions for a specific customer.
string
Filter permissions created after this date. Must be in ISO 8601 format (e.g., ‘2023-07-27T13:54:00’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_GATEWAY_REQUESTSTool to list gateway requests from ProAbono. Use when you need to retrieve payment gateway request history with optional filtering by account, permission, transaction, dates, or request state. Returns paginated results with detailed information about each gateway request including status, amount, and timing.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
The business identifier. Optional parameter to scope the request to a specific business
string
Filter by request state (e.g., ‘Pending’, ‘Success’, ‘Failed’)
string
Filter to retrieve results updated before this date. Use ISO 8601 format (e.g., ‘2025-12-31T23:59:59’)
string
Filter to retrieve results updated after this date. Use ISO 8601 format (e.g., ‘2025-07-27T13:54:00’)
string
Filter to retrieve results created before this date. Use ISO 8601 format (e.g., ‘2025-12-31T23:59:59’)
string
Filter to retrieve results created after this date. Use ISO 8601 format (e.g., ‘2025-07-27T13:54:00’)
integer
Filter by specific gateway account identifier
integer
Filter by gateway permission identifier
integer
Filter by gateway transaction identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_GATEWAY_TRANSACTIONSTool to list gateway transactions from ProAbono. Use when you need to retrieve payment gateway transaction records with optional filtering by business, customer, or update date. Returns paginated results with transaction details including status, amount, and payment type.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to retrieve gateway transactions for a specific business
integer
Filter by Customer ID to retrieve gateway transactions for a specific customer
string
Minimum update date filter in ISO 8601 format (e.g., ‘2023-07-27T13:54:00’). Only transactions updated on or after this date will be returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_INVOICE_LINESList a page of invoice lines from the ProAbono Backoffice API, optionally filtered by business, invoice, or minimum amount. The response does not expose pagination controls or pagination metadata.

Input Parameters

integer
Filter by Invoice ID
integer
Filter by Business ID
integer
Minimum total due amount filter (in cents)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_INVOICESList invoices and credit notes from the ProAbono Backoffice API, with pagination and optional filters for business, technical invoice state, and minimum payment date.

Input Parameters

integer
Page number for pagination (minimum 1).
integer
Number of items per page (minimum 1).
integer
Filter by Business ID to get invoices for a specific business.
string
Filter by invoice state (e.g., ‘Paid’, ‘Due’, ‘Draft’, ‘Problem’, ‘Void’, ‘Uncollectible’). This is the technical state used internally by ProAbono.
string
Minimum payment date filter in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’). Only invoices paid on or after this date will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_INVOICES_BY_CUSTOMERTool to list invoices for a specific customer by their reference identifier from ProAbono API. Use when you need to retrieve all invoices associated with a particular customer using their unique reference from your application.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
string
required
The unique reference of the customer whose invoices you want to retrieve. This is the identifier used within your own application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_OFFERSTool to list all subscription offers (plans) from ProAbono Backoffice API. Use when you need to retrieve available offers with optional filtering by business, state, visibility, or update date.

Input Parameters

integer
Page number. Default: 1.
boolean
Filter offers by visibility status. Set to true to retrieve only visible offers, false for hidden ones.
string
Filter offers by lifecycle state. Common values include ‘Ok’ for active offers.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter offers by Business ID. Use to retrieve offers for a specific business entity.
string
Filter offers updated after this date. Must be in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_PAYMENTSTool to list all payments from ProAbono Backoffice API. Use when you need to retrieve payments with optional filters by business, customer, or update date.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter payments by Business ID
integer
Filter payments by Customer ID
string
Filter payments updated after this date (ISO 8601 format, e.g., 2025-07-27T13:54:00)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_PRICING_TABLE_OFFERSTool to list all pricing table offers via the ProAbono Backoffice API. Use when you need to retrieve all offers configured in pricing tables for a specific business.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
required
Your business ID. This is required to identify which business’s pricing table offers to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_PRICING_TABLESTool to list all pricing tables from ProAbono Backoffice API. Use when you need to retrieve pricing tables with optional filtering by business ID, visibility, or creation date.

Input Parameters

integer
Page number. Default: 1.
boolean
Filter by visibility status
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID
string
Minimum creation date filter in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SEGMENT_LOCALIZATIONSTool to list localization entries by segment from ProAbono Backoffice API. Use when you need to retrieve hosted page localizations for a specific segment with optional filtering by language, custom status, content, or code.

Input Parameters

string
Search localizations by specific localization code
integer
Page number. Default: 1.
string
Search localizations containing specified content text
boolean
Filter for customized localizations - true to show only custom localizations, false for default localizations
string
Filter by specific language code (e.g., ‘EN’, ‘FR’)
integer
required
The segment ID for which to retrieve localizations
integer
Number of items per page. Default: 10, max: 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SEGMENTSTool to list all segments from ProAbono via the Backoffice API. Use when you need to retrieve segments with optional filtering by business ID or currency. Returns a paginated collection of segment objects including configuration details, hosts, and navigation links.

Input Parameters

integer
Page number. Default: 1.
string
Filter by currency code (e.g., ‘EUR’, ‘USD’, ‘GBP’)
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to list segments for a specific business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SUBSCRIPTION_DISCOUNTSList subscription-discount associations for a business via the ProAbono Backoffice API. Returns paginated records with IDs, timestamps, and associated subscription and discount IDs.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
required
Your business ID - required to retrieve subscription discounts for a specific business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SUBSCRIPTION_FEATURESTool to list all subscription features via the ProAbono Backoffice API. Use when you need to retrieve subscription features with optional filtering by Business ID, Feature ID, or minimum update date.

Input Parameters

integer
Filter subscription features by Feature ID
integer
Filter subscription features by Business ID
string
Minimum update date filter in ISO 8601 format (e.g., 2025-08-27T13:54:00)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SUBSCRIPTION_PERIODSTool to list all subscription periods (billing cycles) from ProAbono Backoffice API. Use when you need to retrieve subscription period information with optional filtering by business ID, subscription ID, or start date. Supports pagination for large result sets.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID. Use this to retrieve subscription periods for a specific business.
string
Minimum start date filter in ISO 8601 format (e.g., ‘2025-08-27T13:54:00’). Returns periods that start on or after this date.
integer
Filter by Subscription ID. Use this to retrieve periods for a specific subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_SUBSCRIPTIONSTool to list all subscriptions from ProAbono via the Backoffice API. Use when you need to retrieve subscription information with optional filtering by business, state, or start date. Returns paginated results with subscription details including customer, offer, dates, and status.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to retrieve subscriptions for a specific business
string
Minimum start date filter in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’)
string
Filter by subscription technical state (e.g., ‘ActiveRunning’, ‘Draft’, ‘Suspended’, ‘Ended’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_TAX_PROFILE_EXCEPTIONSTool to list tax profile exceptions from ProAbono Organization API. Use when you need to retrieve tax exceptions with optional filtering by business, tax profile, country, or region. Returns a paginated collection of tax exception records including rates, geographic scope, and applicability.

Input Parameters

integer
Page number. Default: 1.
string
Filter by region or state code (e.g., ‘US-CA’ for California, ‘US-TX’ for Texas)
string
Filter by ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘FR’, ‘GB’)
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by business identifier to retrieve tax profile exceptions for a specific business
integer
Filter by tax profile identifier to retrieve exceptions for a specific tax profile

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_TAX_PROFILESTool to list all tax profiles from ProAbono via the Backoffice API. Use when you need to retrieve tax configurations with optional filtering by business ID. Returns a paginated collection of tax profile objects with rates and settings.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
integer
Filter by Business ID to list tax profiles for a specific business

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_UPGRADE_OFFERSList offers for a customer by reference, with optional pagination and an UpgradeOnly query parameter.

Input Parameters

integer
Page number. Default: 1.
integer
Number of items per page. Default: 10, max: 1000.
boolean
Filter to show only upgrade offers. When true, returns only offers that represent an upgrade from the customer’s current subscription
string
required
The unique reference identifier of the customer to retrieve upgrade offers for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_WEBHOOK_NOTIFICATIONSList webhook notification history for a business, with optional segment, date range, state, or webhook ID filters. Returns paginated notification details including sending status and related resources.

Input Parameters

integer
Page number. Default: 1.
integer
Filter by specific segment identifier to retrieve notifications for a particular segment only
integer
Filter by webhook identifier to retrieve notifications for a specific webhook only
string
Filter by specific state of the webhook notification (e.g., ‘Ok’, ‘Failed’)
integer
Number of items per page. Default: 10, max: 1000.
integer
required
Your business identifier. Required to retrieve webhook notifications for a specific business.
string
Notifications updated before this date in ISO 8601 format. Use to filter by maximum update date.
string
Notifications updated after this date in ISO 8601 format. Use to filter by minimum update date.
string
Notifications created before this date in ISO 8601 format (e.g., ‘2025-12-31T23:59:59’). Use to filter by maximum creation date.
string
Notifications created after this date in ISO 8601 format (e.g., ‘2025-07-27T13:54:00’). Use to filter by minimum creation date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_LIST_WEBHOOKSTool to list webhooks from ProAbono Notification API. Use when you need to retrieve configured webhooks with optional filtering by creation date, update date, or state.

Input Parameters

integer
Page number. Default: 1.
string
Filter webhooks by state. Common values include ‘Ok’ for active webhooks and ‘DisabledUser’ for disabled webhooks.
integer
Number of items per page. Default: 10, max: 1000.
integer
required
Your business identifier. This is a required parameter to identify which business’s webhooks to retrieve.
string
Filter webhooks updated before a specific date. Must be in ISO 8601 format (e.g., ‘2025-04-27T23:59:59’).
string
Filter webhooks updated after a specific date. Must be in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’).
string
Filter webhooks created before a specific date. Must be in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’).
string
Filter webhooks created after a specific date. Must be in ISO 8601 format (e.g., ‘2025-04-27T13:54:00’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_QUOTE_BALANCE_LINERequest a pricing quote for a customer’s proposed balance line, such as a one-time charge or credit. Use it to assess the amount including applicable taxes before creating the line.

Input Parameters

string
required
Description or label for the balance line item. This will appear on invoices and billing statements.
integer
required
Amount in the smallest currency unit (e.g., cents for USD, pennies for GBP). For example, $15.00 would be 1500.
boolean
If true (default), validates that the customer has valid payment information configured. The quote endpoint requires valid payment settings regardless of this parameter value.
string
required
The unique reference of the customer for whom to calculate the balance line pricing. This is the customer identifier shared between your application and ProAbono.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_BUSINESSES_BILLING_ADDRESSTool to update business billing address via the Backoffice API. Use when you need to modify billing information including company name, contact details, address lines, and tax information for a specific business.

Input Parameters

integer
required
Business identifier whose billing address to update
string
City name
string
Contact phone number
string
Region stands for Subdivision, Department, Region, Province, State. Note: Region field may have business rule restrictions preventing updates.
string
Name of the company billing customers
string
Two-letter country code per ISO 3166-1 alpha-2. Note: Country field may have business rule restrictions preventing updates.
string
Postal code
string
Individual name or department contact
string
Individual name or department contact
string
Primary address line
string
Secondary address line (floor, suite, building, etc.)
string
VAT/TAX identification number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_CUSTOMERTool to update an existing customer in ProAbono via the Backoffice API. Use when you need to modify customer properties such as name, email, or language preferences. Allows partial updates.

Input Parameters

integer
required
The unique identifier of the customer to update
string
Display name of the customer. Use this to update the customer’s full name
string
Customer’s email address. Use this to update the customer’s contact email
string
Customer’s preferred language in ISO 639-1 format (2-letter code). Use this to update the customer’s language preference
integer
The business identifier. Optional parameter to scope the request to a specific business
string
Your custom reference for the customer shared between ProAbono and your application

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_CUSTOMER_BILLING_ADDRESSTool to update the billing address for a customer in ProAbono via the API. Use when you need to modify billing address information including company name, contact details, address lines, and tax information. Once updated, ProAbono will use this information for future invoices.

Input Parameters

string
City name of the billing address
string
Phone number for the billing address
string
ISO 3166-2 region code representing subdivision, department, region, province, or state. Required for certain countries like US (e.g., CA for California), optional for others like FR.
string
Name of the company for billing purposes
string
ISO 3166-1 alpha-2 country code of the billing address (e.g., FR for France, US for United States)
string
Postal code or ZIP code of the billing address
string
Last name of the billing address holder
string
First name of the billing address holder
string
Primary address line of the billing address
string
Secondary address line (optional, for apartment, suite, etc.)
string
Tax information such as VAT ID, Num TVA Intra, GST, or other tax identification number
string
required
The unique reference of the customer whose billing address to update. This is the shared identifier between ProAbono and your application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_CUSTOMER_PAYMENT_SETTINGSUpdate a customer’s payment method using their customer reference in ProAbono. Setting a manual payment method makes payment collection your responsibility.

Input Parameters

string
The manual payment method type to set. Possible values: Card, ExternalBank, ExternalCash, ExternalCheck, ExternalOther. When set, payment collection becomes your responsibility
string
required
The unique reference identifier of the customer whose payment settings you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_CUSTOMER_SHIPPINGTool to update customer shipping address via the Backoffice API. Use when you need to modify shipping information including company name, contact details, address lines, and tax information for a specific customer.

Input Parameters

integer
required
The customer ID whose shipping address to update
string
City name
string
Phone number
string
ISO 3166-2 region/province code
string
Company name
string
ISO 3166-1 alpha-2 country code
string
Postal code
string
Last name
string
First name
integer
required
Your Business ID
string
Primary address line
string
Secondary address line
string
VAT ID or tax identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_FEATURETool to update an existing feature in ProAbono via the Backoffice API. Use when you need to modify feature properties such as name, visibility, type, or display order.

Input Parameters

integer
required
ID of the feature to update
string
The feature name displayed to users
integer
Display position among other features (lower numbers appear first)
boolean
Whether to show this feature in offers and hosted pages
integer
Your Business identifier
string ("OnOff" | "Limitation" | "Consumption")
Feature type enumeration.
string
Shared key between ProAbono and your system for identifying this feature

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PROABONO_UPDATE_TAX_PROFILESTool to update an existing tax profile in ProAbono via the Backoffice API. Use when you need to modify tax profile properties such as name, description, label, or tax rates.

Input Parameters

integer
required
The ID of the tax profile to update
string
Name of the tax profile to update
string
Display label for the tax (maximum 10 characters)
integer
required
The ID of the business
string
Description of the tax profile to provide additional context
integer
Default tax rate in per-myriad (e.g., 2500 for 25%, 1000 for 10%, 1560 for 15.6%). Must be a non-negative integer
string
Type of tax rate applied (e.g., ‘Standard’, ‘Reduced’, ‘Outside’, ‘Zero’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not