Proabono
proabonoProAbono is the smart subscription management software that automates your daily routine.
Acciones disponibles (67)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Anonymize CustomerPROABONO_ANONYMIZE_CUSTOMERAcciónTool 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.
PROABONO_ANONYMIZE_CUSTOMERAcciónTool 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.
Parámetros de entrada
reference_customerstringObligatorioThe unique reference of the customer to anonymize. This is your application's customer reference identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bill CustomerPROABONO_BILL_CUSTOMERAcciónTool to trigger billing for a customer. Use when you need to create invoices for pending charges for a specific customer.
PROABONO_BILL_CUSTOMERAcciónTool to trigger billing for a customer. Use when you need to create invoices for pending charges for a specific customer.
Parámetros de entrada
ReferenceCustomerstringObligatorioThe unique reference of the customer to bill. This identifier is used to trigger billing and create invoices for pending charges.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CustomerPROABONO_CREATE_CUSTOMERAcciónTool 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.
PROABONO_CREATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
NamestringDisplay Name of your customer
EmailstringObligatorioEmail of your customer
LanguagestringLanguage of your customer. By Default, ProAbono will use the language of the segment
MetadataobjectCustom key-value metadata for the customer (max 5 pairs, 50-char keys, 450-char values)
IdBusinessintegerObligatorioId of your Business
ReferenceSegmentstringReference of the segment in which the customer will be created. Required only if you have more than 1 segment
ReferenceCustomerstringReference of your customer shared with your application and ProAbono. Use your own id/reference user
ReferenceAffiliationstringReference of the affiliate
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create FeaturePROABONO_CREATE_FEATUREAcciónTool 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.
PROABONO_CREATE_FEATUREAcciónTool 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.
Parámetros de entrada
NamestringThe feature name displayed to users
OrderintegerDisplay position among other features (lower numbers appear first)
IsVisiblebooleanWhether to show this feature in offers and hosted pages
IdBusinessintegerObligatorioYour Business identifier
TypeFeaturestringenumFeature type enumeration.
OnOffLimitationConsumptionReferenceFeaturestringShared key between ProAbono and your system for identifying this feature
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerPROABONO_DELETE_CUSTOMERAcciónTool to delete a customer from ProAbono by ID. Use when you need to remove a customer record from the system.
PROABONO_DELETE_CUSTOMERAcciónTool to delete a customer from ProAbono by ID. Use when you need to remove a customer record from the system.
Parámetros de entrada
idintegerObligatorioID of the customer to delete. This is the unique customer identifier in ProAbono.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OfferPROABONO_DELETE_OFFERAcciónTool to delete an offer from ProAbono by ID. Use when you need to permanently remove an offer from the system.
PROABONO_DELETE_OFFERAcciónTool to delete an offer from ProAbono by ID. Use when you need to permanently remove an offer from the system.
Parámetros de entrada
idintegerObligatorioThe unique ID of the offer to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Pricing TablePROABONO_DELETE_PRICING_TABLEAcciónTool to delete a pricing table from ProAbono by its ID. Use when you need to remove a pricing table from the system.
PROABONO_DELETE_PRICING_TABLEAcciónTool to delete a pricing table from ProAbono by its ID. Use when you need to remove a pricing table from the system.
Parámetros de entrada
idintegerObligatorioThe unique ID of the pricing table to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Pricing Table OfferPROABONO_DELETE_PRICING_TABLE_OFFERAcciónTool 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.
PROABONO_DELETE_PRICING_TABLE_OFFERAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the pricing table offer to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscription DiscountPROABONO_DELETE_SUBSCRIPTION_DISCOUNTAcciónTool to delete a subscription discount via the Backoffice API. Use when you need to remove a discount from a subscription after confirming its ID.
PROABONO_DELETE_SUBSCRIPTION_DISCOUNTAcciónTool to delete a subscription discount via the Backoffice API. Use when you need to remove a discount from a subscription after confirming its ID.
Parámetros de entrada
idintegerObligatorioThe subscription discount ID to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable WebhookPROABONO_ENABLE_WEBHOOKAcciónTool to enable a webhook in ProAbono via the Notification API. Use when you need to activate a previously disabled webhook for receiving event notifications.
PROABONO_ENABLE_WEBHOOKAcciónTool to enable a webhook in ProAbono via the Notification API. Use when you need to activate a previously disabled webhook for receiving event notifications.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the webhook to enable. Must be a valid webhook ID from your ProAbono account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer by IDPROABONO_GET_CUSTOMERAcciónTool to retrieve a single customer by ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific customer including their billing details, status, and related resource links.
PROABONO_GET_CUSTOMERAcciónTool to retrieve a single customer by ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific customer including their billing details, status, and related resource links.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the customer to retrieve
id_businessintegerThe business identifier. Optional parameter to scope the request to a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer Billing AddressPROABONO_GET_CUSTOMER_BILLINGAcciónTool 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.
PROABONO_GET_CUSTOMER_BILLINGAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe customer ID whose billing address to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer Billing Address by ReferencePROABONO_GET_CUSTOMER_BILLING_ADDRESSAcciónTool 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.
PROABONO_GET_CUSTOMER_BILLING_ADDRESSAcciónTool 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.
Parámetros de entrada
reference_customerstringObligatorioThe unique reference of the customer to retrieve billing address for. This is the shared identifier between ProAbono and your application.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer by ReferencePROABONO_GET_CUSTOMER_BY_REFERENCEAcciónTool 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.
PROABONO_GET_CUSTOMER_BY_REFERENCEAcciónTool 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.
Parámetros de entrada
reference_customerstringObligatorioThe unique reference identifier of the customer to retrieve, used within your own application
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer Payment SettingsPROABONO_GET_CUSTOMER_PAYMENT_SETTINGSAcciónTool to retrieve customer payment settings via the Backoffice API. Use when you need to check a customer's payment configuration, billing schedule, or payment method type.
PROABONO_GET_CUSTOMER_PAYMENT_SETTINGSAcciónTool to retrieve customer payment settings via the Backoffice API. Use when you need to check a customer's payment configuration, billing schedule, or payment method type.
Parámetros de entrada
ReferenceCustomerstringObligatorioThe unique reference identifier of the customer whose payment settings to retrieve (ReferenceCustomer property)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DiscountPROABONO_GET_DISCOUNTAcciónTool to retrieve a discount by ID via the Backoffice API. Use when you need to fetch details of a specific discount including its amount, type, target fees, and state.
PROABONO_GET_DISCOUNTAcciónTool to retrieve a discount by ID via the Backoffice API. Use when you need to fetch details of a specific discount including its amount, type, target fees, and state.
Parámetros de entrada
IdintegerObligatorioThe discount ID to retrieve
IdBusinessintegerObligatorioYour business ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Feature by IDPROABONO_GET_FEATUREAcciónTool to retrieve a feature by ID from ProAbono Backoffice API. Use when you need to fetch details about a specific feature.
PROABONO_GET_FEATUREAcciónTool to retrieve a feature by ID from ProAbono Backoffice API. Use when you need to fetch details about a specific feature.
Parámetros de entrada
idintegerObligatorioID of the feature to retrieve
id_businessstringOptional business identifier filter
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Feature by ReferencePROABONO_GET_FEATURE_BY_REFERENCEAcciónTool to retrieve a single feature by its reference from ProAbono API. Use when you need to fetch details about a specific feature using its unique reference identifier.
PROABONO_GET_FEATURE_BY_REFERENCEAcciónTool to retrieve a single feature by its reference from ProAbono API. Use when you need to fetch details about a specific feature using its unique reference identifier.
Parámetros de entrada
reference_featurestringObligatorioThe reference of the feature to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get InvoicePROABONO_GET_INVOICEAcciónTool to retrieve a specific invoice or credit note by ID from ProAbono. Use when you need to fetch detailed information about an invoice.
PROABONO_GET_INVOICEAcciónTool to retrieve a specific invoice or credit note by ID from ProAbono. Use when you need to fetch detailed information about an invoice.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the invoice or credit note to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Offer by IDPROABONO_GET_OFFERAcciónTool to retrieve a single offer by its ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific offer.
PROABONO_GET_OFFERAcciónTool to retrieve a single offer by its ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific offer.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the offer to retrieve
id_businessintegerObligatorioThe business identifier. Required to scope the request to a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Subscription by Customer ReferencePROABONO_GET_SUBSCRIPTION_BY_CUSTOMERAcciónTool to retrieve a subscription by customer reference from ProAbono. Use when you need to fetch subscription details for a specific customer using their reference key.
PROABONO_GET_SUBSCRIPTION_BY_CUSTOMERAcciónTool to retrieve a subscription by customer reference from ProAbono. Use when you need to fetch subscription details for a specific customer using their reference key.
Parámetros de entrada
id_businessintegerThe business identifier. Optional parameter to scope the request to a specific business
reference_customerstringObligatorioThe unique reference of the customer to retrieve their subscription
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Subscription Creation QuotePROABONO_GET_SUBSCRIPTION_CREATION_QUOTEAcciónTool 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.
PROABONO_GET_SUBSCRIPTION_CREATION_QUOTEAcciónTool 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.
Parámetros de entrada
ReferenceOfferstringObligatorioThe reference of the offer to quote for subscription creation
ReferenceCustomerstringObligatorioThe unique reference of the customer for whom the subscription quote is being generated
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Usage RecordPROABONO_GET_USAGEAcciónTool 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.
PROABONO_GET_USAGEAcciónTool 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.
Parámetros de entrada
ReferenceFeaturestringObligatorioThe reference of the feature to retrieve usage for. This is the shared key between ProAbono and your application.
ReferenceCustomerstringObligatorioThe unique reference of the customer to retrieve usage for. This is the identifier from your application.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Usages for CustomerPROABONO_GET_USAGES_FOR_CUSTOMERAcciónTool 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.
PROABONO_GET_USAGES_FOR_CUSTOMERAcciónTool 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.
Parámetros de entrada
IdCustomerintegerRetrieve usages exclusively from a specific customer by ID
IdSubscriptionintegerRetrieve usages exclusively from a specific subscription by ID
ReferenceCustomerstringReference of the customer - retrieve usages exclusively from this customer
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Invalidate CustomerPROABONO_INVALIDATE_CUSTOMERAcciónTool to invalidate a customer by their reference. Use when you need to revoke a customer's access to subscribed services while keeping the account record.
PROABONO_INVALIDATE_CUSTOMERAcciónTool to invalidate a customer by their reference. Use when you need to revoke a customer's access to subscribed services while keeping the account record.
Parámetros de entrada
reference_customerstringObligatorioThe unique reference of the customer to invalidate. This is your application's customer reference identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Invalidate Customer by IDPROABONO_INVALIDATE_CUSTOMER_BY_IDAcciónTool 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.
PROABONO_INVALIDATE_CUSTOMER_BY_IDAcciónTool 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.
Parámetros de entrada
id_customerintegerObligatorioThe 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Balance LinesPROABONO_LIST_BALANCE_LINESAcciónTool to list all balance lines from ProAbono. Use when you need to retrieve one-time charges or credits associated with a customer or subscription. Either ReferenceCustomer or IdSubscription parameter is required.
PROABONO_LIST_BALANCE_LINESAcciónTool to list all balance lines from ProAbono. Use when you need to retrieve one-time charges or credits associated with a customer or subscription. Either ReferenceCustomer or IdSubscription parameter is required.
Parámetros de entrada
nextBillingbooleanFlag 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.
IdSubscriptionintegerThe ID of the subscription to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.
ReferenceCustomerstringThe reference of the customer to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List BusinessesPROABONO_LIST_BUSINESSESAcciónTool 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.
PROABONO_LIST_BUSINESSESAcciónTool 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.
Parámetros de entrada
StateLifestringFilter businesses by lifecycle state. Common values include 'Ok' for active businesses.
DateUpdateMinstringFilter businesses updated after this date. Must be in ISO 8601 format (e.g., '2023-04-27T06:54:00').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Business LocalizationPROABONO_LIST_BUSINESS_LOCALIZATIONAcciónTool 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.
PROABONO_LIST_BUSINESS_LOCALIZATIONAcciónTool 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.
Parámetros de entrada
CodestringFilter localizations by code keyword. Returns localizations containing the specified text in their code field.
ContentstringFilter localizations by content keyword. Returns localizations containing the specified text in their content field.
IsCustombooleanFilter for custom localizations. Set to true to retrieve only customized localizations, false for standard localizations.
LanguagestringFilter localizations by language code (ISO 639-1 format, e.g., 'en', 'fr'). Returns only localizations matching this language.
IdBusinessintegerObligatorioID of the business to retrieve localizations for. This is a required parameter.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Customer MovesPROABONO_LIST_CUSTOMER_MOVESAcciónTool to list all customer balance moves via the ProAbono Backoffice API. Use when you need to retrieve balance transactions, credits, debits, or billing movements for customers. Supports filtering by customer, billing status, and date range with pagination.
PROABONO_LIST_CUSTOMER_MOVESAcciónTool to list all customer balance moves via the ProAbono Backoffice API. Use when you need to retrieve balance transactions, credits, debits, or billing movements for customers. Supports filtering by customer, billing status, and date range with pagination.
Parámetros de entrada
PageintegerPage number for paginated results. Defaults to 1 if not specified.
CountbooleanWhether to include total count in the response. Defaults to true.
LinksbooleanWhether to generate HATEOAS links in the response. Defaults to true.
SizePageintegerNumber of items per page. Maximum is 1000.
IdBusinessintegerObligatorioYour business ID. This is required to identify which business to query.
IdCustomerintegerCustomer identifier to filter moves for a specific customer
IsNotBilledbooleanFilter to show only unbilled moves (true) or all moves (false/null)
DateUpdateMinstringFilter moves updated after this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersPROABONO_LIST_CUSTOMERSAcciónTool 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.
PROABONO_LIST_CUSTOMERSAcciónTool 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.
Parámetros de entrada
LanguagestringFilter by language code (ISO 639-1 format, e.g., 'EN', 'FR')
StateLifestringFilter by state life status of the customer (e.g., 'Ok')
IdBusinessintegerFilter by Business ID to retrieve customers for a specific business
DateCreationMinstringMinimum creation date filter in ISO 8601 format (e.g., '2025-07-27T13:54:00')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Customers by FeaturePROABONO_LIST_CUSTOMERS_BY_FEATUREAcciónTool to list customers that have access to a specific feature via the ProAbono API. Use when you need to identify which customers have subscriptions containing a particular feature. Returns feature-specific details including quota usage and billing period information. Note: Returns HTTP 204 (No Content) when no customers match the feature filter.
PROABONO_LIST_CUSTOMERS_BY_FEATUREAcciónTool to list customers that have access to a specific feature via the ProAbono API. Use when you need to identify which customers have subscriptions containing a particular feature. Returns feature-specific details including quota usage and billing period information. Note: Returns HTTP 204 (No Content) when no customers match the feature filter.
Parámetros de entrada
PageintegerPage number for pagination (starts at 1)
SizePageintegerNumber of results per page (default and maximum values are API-defined)
ReferenceFeaturestringObligatorioReference of the Feature to filter customers having active subscriptions containing that specific feature
ReferenceSegmentstringLimit results to customers in a specific segment
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DiscountsPROABONO_LIST_DISCOUNTSAcciónTool 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).
PROABONO_LIST_DISCOUNTSAcciónTool 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).
Parámetros de entrada
IdBusinessintegerFilter by Business ID to retrieve discounts for a specific business
stateDiscountstringFilter by discount state. Use 'Enabled' for active discounts or 'Draft' for inactive ones
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List FeaturesPROABONO_LIST_FEATURESAcciónTool 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.
PROABONO_LIST_FEATURESAcciónTool 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.
Parámetros de entrada
IsVisiblebooleanFilter by visibility status - true to show only visible features, false for hidden features
StateLifestringFilter by feature lifecycle state (e.g., 'Ok')
IdBusinessintegerFilter by Business ID to list features for a specific business
DateCreationMinstringMinimum creation date filter in ISO 8601 format (e.g., '2025-04-27T13:54:00')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Features (V1)PROABONO_LIST_FEATURES_V1AcciónTool to retrieve all features from ProAbono API using the /v1/Features endpoint. Use when you need to get a list of all available features, optionally filtered by business ID.
PROABONO_LIST_FEATURES_V1AcciónTool to retrieve all features from ProAbono API using the /v1/Features endpoint. Use when you need to get a list of all available features, optionally filtered by business ID.
Parámetros de entrada
id_businessstringOptional business ID filter parameter to retrieve features for a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Gateway AccountsPROABONO_LIST_GATEWAY_ACCOUNTSAcciónTool 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.
PROABONO_LIST_GATEWAY_ACCOUNTSAcciónTool 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.
Parámetros de entrada
CurrencystringFilter by currency code in ISO 4217 format (e.g., 'USD', 'EUR')
IdBusinessintegerFilter by Business ID to retrieve gateway accounts for a specific business
IsInRealMoneybooleanFilter by real money mode. Set to true for live accounts, false for test accounts.
DateCreationMinstringMinimum creation date filter in ISO 8601 format (e.g., '2023-07-27T13:54:00')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Gateway PermissionsPROABONO_LIST_GATEWAY_PERMISSIONSAcciónTool to list gateway permissions from ProAbono API. Use when you need to retrieve payment permissions with optional filtering by business, customer, or creation date.
PROABONO_LIST_GATEWAY_PERMISSIONSAcciónTool to list gateway permissions from ProAbono API. Use when you need to retrieve payment permissions with optional filtering by business, customer, or creation date.
Parámetros de entrada
IdBusinessintegerFilter by Business ID. Use to retrieve permissions for a specific business entity.
IdCustomerintegerFilter by Customer ID. Use to retrieve permissions for a specific customer.
DateCreationMinstringFilter permissions created after this date. Must be in ISO 8601 format (e.g., '2023-07-27T13:54:00').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Gateway RequestsPROABONO_LIST_GATEWAY_REQUESTSAcciónTool 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.
PROABONO_LIST_GATEWAY_REQUESTSAcciónTool 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.
Parámetros de entrada
id_businessintegerThe business identifier. Optional parameter to scope the request to a specific business
StateRequeststringFilter by request state (e.g., 'Pending', 'Success', 'Failed')
DateUpdateMaxstringFilter to retrieve results updated before this date. Use ISO 8601 format (e.g., '2025-12-31T23:59:59')
DateUpdateMinstringFilter to retrieve results updated after this date. Use ISO 8601 format (e.g., '2025-07-27T13:54:00')
DateCreationMaxstringFilter to retrieve results created before this date. Use ISO 8601 format (e.g., '2025-12-31T23:59:59')
DateCreationMinstringFilter to retrieve results created after this date. Use ISO 8601 format (e.g., '2025-07-27T13:54:00')
IdGatewayAccountintegerFilter by specific gateway account identifier
IdGatewayPermissionintegerFilter by gateway permission identifier
IdGatewayTransactionintegerFilter by gateway transaction identifier
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Gateway TransactionsPROABONO_LIST_GATEWAY_TRANSACTIONSAcciónTool 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.
PROABONO_LIST_GATEWAY_TRANSACTIONSAcciónTool 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.
Parámetros de entrada
IdBusinessintegerFilter by Business ID to retrieve gateway transactions for a specific business
IdCustomerintegerFilter by Customer ID to retrieve gateway transactions for a specific customer
DateUpdateMinstringMinimum 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
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Invoice LinesPROABONO_LIST_INVOICE_LINESAcciónTool to list all invoice lines from ProAbono via the Backoffice API. Use when you need to retrieve invoice line items with optional filtering by business, invoice, or minimum amount.
PROABONO_LIST_INVOICE_LINESAcciónTool to list all invoice lines from ProAbono via the Backoffice API. Use when you need to retrieve invoice line items with optional filtering by business, invoice, or minimum amount.
Parámetros de entrada
IdInvoiceintegerFilter by Invoice ID
IdBusinessintegerFilter by Business ID
AmountTotalDueMinintegerMinimum total due amount filter (in cents)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Invoices and Credit NotesPROABONO_LIST_INVOICESAcciónTool to list all invoices and credit notes from ProAbono Backoffice API. Use when you need to retrieve invoice data with optional filtering by business, payment state, or date range. Supports pagination for large result sets.
PROABONO_LIST_INVOICESAcciónTool to list all invoices and credit notes from ProAbono Backoffice API. Use when you need to retrieve invoice data with optional filtering by business, payment state, or date range. Supports pagination for large result sets.
Parámetros de entrada
PageintegerPage number for pagination (minimum 1).
SizePageintegerNumber of items per page (minimum 1).
IdBusinessintegerFilter by Business ID to get invoices for a specific business.
StateInvoicestringFilter by invoice state (e.g., 'Paid', 'Due', 'Draft', 'Problem', 'Void', 'Uncollectible'). This is the technical state used internally by ProAbono.
DatePaymentMinstringMinimum 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Invoices by Customer ReferencePROABONO_LIST_INVOICES_BY_CUSTOMERAcciónTool 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.
PROABONO_LIST_INVOICES_BY_CUSTOMERAcciónTool 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.
Parámetros de entrada
reference_customerstringObligatorioThe unique reference of the customer whose invoices you want to retrieve. This is the identifier used within your own application.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List OffersPROABONO_LIST_OFFERSAcciónTool 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.
PROABONO_LIST_OFFERSAcciónTool 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.
Parámetros de entrada
IsVisiblebooleanFilter offers by visibility status. Set to true to retrieve only visible offers, false for hidden ones.
StateLifestringFilter offers by lifecycle state. Common values include 'Ok' for active offers.
IdBusinessintegerFilter offers by Business ID. Use to retrieve offers for a specific business entity.
DateUpdateMinstringFilter offers updated after this date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsPROABONO_LIST_PAYMENTSAcciónTool to list all payments from ProAbono Backoffice API. Use when you need to retrieve payments with optional filters by business, customer, or update date.
PROABONO_LIST_PAYMENTSAcciónTool to list all payments from ProAbono Backoffice API. Use when you need to retrieve payments with optional filters by business, customer, or update date.
Parámetros de entrada
IdBusinessintegerFilter payments by Business ID
IdCustomerintegerFilter payments by Customer ID
DateUpdateMinstringFilter payments updated after this date (ISO 8601 format, e.g., 2025-07-27T13:54:00)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Pricing Table OffersPROABONO_LIST_PRICING_TABLE_OFFERSAcciónTool 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.
PROABONO_LIST_PRICING_TABLE_OFFERSAcciónTool 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.
Parámetros de entrada
IdBusinessintegerObligatorioYour business ID. This is required to identify which business's pricing table offers to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Pricing TablesPROABONO_LIST_PRICING_TABLESAcciónTool 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.
PROABONO_LIST_PRICING_TABLESAcciónTool 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.
Parámetros de entrada
IsVisiblebooleanFilter by visibility status
IdBusinessintegerFilter by Business ID
DateCreationMinstringMinimum creation date filter in ISO 8601 format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Segment LocalizationsPROABONO_LIST_SEGMENT_LOCALIZATIONSAcciónTool 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.
PROABONO_LIST_SEGMENT_LOCALIZATIONSAcciónTool 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.
Parámetros de entrada
CodestringSearch localizations by specific localization code
ContentstringSearch localizations containing specified content text
IsCustombooleanFilter for customized localizations - true to show only custom localizations, false for default localizations
LanguagestringFilter by specific language code (e.g., 'EN', 'FR')
IdSegmentintegerObligatorioThe segment ID for which to retrieve localizations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SegmentsPROABONO_LIST_SEGMENTSAcciónTool 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.
PROABONO_LIST_SEGMENTSAcciónTool 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.
Parámetros de entrada
CurrencystringFilter by currency code (e.g., 'EUR', 'USD', 'GBP')
IdBusinessintegerFilter by Business ID to list segments for a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription DiscountsPROABONO_LIST_SUBSCRIPTION_DISCOUNTSAcciónTool to list all subscription discounts via the ProAbono Backoffice API. Use when you need to retrieve discounts applied to subscriptions for a specific business. Returns paginated results with discount details including IDs, creation/update timestamps, and associated subscription and discount references.
PROABONO_LIST_SUBSCRIPTION_DISCOUNTSAcciónTool to list all subscription discounts via the ProAbono Backoffice API. Use when you need to retrieve discounts applied to subscriptions for a specific business. Returns paginated results with discount details including IDs, creation/update timestamps, and associated subscription and discount references.
Parámetros de entrada
IdBusinessintegerObligatorioYour business ID - required to retrieve subscription discounts for a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription FeaturesPROABONO_LIST_SUBSCRIPTION_FEATURESAcciónTool 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.
PROABONO_LIST_SUBSCRIPTION_FEATURESAcciónTool 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.
Parámetros de entrada
IdFeatureintegerFilter subscription features by Feature ID
IdBusinessintegerFilter subscription features by Business ID
DateUpdateMinstringMinimum update date filter in ISO 8601 format (e.g., 2025-08-27T13:54:00)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription PeriodsPROABONO_LIST_SUBSCRIPTION_PERIODSAcciónTool 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.
PROABONO_LIST_SUBSCRIPTION_PERIODSAcciónTool 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.
Parámetros de entrada
IdBusinessintegerFilter by Business ID. Use this to retrieve subscription periods for a specific business.
DateStartMinstringMinimum start date filter in ISO 8601 format (e.g., '2025-08-27T13:54:00'). Returns periods that start on or after this date.
IdSubscriptionintegerFilter by Subscription ID. Use this to retrieve periods for a specific subscription.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubscriptionsPROABONO_LIST_SUBSCRIPTIONSAcciónTool 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.
PROABONO_LIST_SUBSCRIPTIONSAcciónTool 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.
Parámetros de entrada
IdBusinessintegerFilter by Business ID to retrieve subscriptions for a specific business
dateStartMinstringMinimum start date filter in ISO 8601 format (e.g., '2025-04-27T13:54:00')
StateSubscriptionstringFilter by subscription technical state (e.g., 'ActiveRunning', 'Draft', 'Suspended', 'Ended')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscriptions (V1)PROABONO_LIST_SUBSCRIPTIONS_V1AcciónTool to retrieve all subscriptions from ProAbono API using the /v1/Subscriptions endpoint. Use when you need to get a paginated list of all subscriptions, optionally filtered by business ID.
PROABONO_LIST_SUBSCRIPTIONS_V1AcciónTool to retrieve all subscriptions from ProAbono API using the /v1/Subscriptions endpoint. Use when you need to get a paginated list of all subscriptions, optionally filtered by business ID.
Parámetros de entrada
PageintegerPage number for pagination, starting from 1
SizePageintegerNumber of results per page for pagination
id_businessstringOptional business ID filter parameter to retrieve subscriptions for a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Tax Profile ExceptionsPROABONO_LIST_TAX_PROFILE_EXCEPTIONSAcciónTool 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.
PROABONO_LIST_TAX_PROFILE_EXCEPTIONSAcciónTool 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.
Parámetros de entrada
regionstringFilter by region or state code (e.g., 'US-CA' for California, 'US-TX' for Texas)
countrystringFilter by ISO 3166-1 alpha-2 country code (e.g., 'US', 'FR', 'GB')
id_businessintegerFilter by business identifier to retrieve tax profile exceptions for a specific business
id_tax_profileintegerFilter by tax profile identifier to retrieve exceptions for a specific tax profile
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Tax ProfilesPROABONO_LIST_TAX_PROFILESAcciónTool 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.
PROABONO_LIST_TAX_PROFILESAcciónTool 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.
Parámetros de entrada
IdBusinessintegerFilter by Business ID to list tax profiles for a specific business
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Upgrade OffersPROABONO_LIST_UPGRADE_OFFERSAcciónTool to retrieve offers available to upgrade an existing customer subscription. Use when you need to show upgrade options to a customer based on their current subscription status.
PROABONO_LIST_UPGRADE_OFFERSAcciónTool to retrieve offers available to upgrade an existing customer subscription. Use when you need to show upgrade options to a customer based on their current subscription status.
Parámetros de entrada
UpgradeOnlybooleanFilter to show only upgrade offers. When true, returns only offers that represent an upgrade from the customer's current subscription
ReferenceCustomerstringObligatorioThe unique reference identifier of the customer to retrieve upgrade offers for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Webhook NotificationsPROABONO_LIST_WEBHOOK_NOTIFICATIONSAcciónTool to list webhook notifications from ProAbono via the Notification API. Use when you need to retrieve webhook notification history with optional filtering by business, segment, date range, state, or webhook ID. Returns paginated results with notification details including sending status and related resources.
PROABONO_LIST_WEBHOOK_NOTIFICATIONSAcciónTool to list webhook notifications from ProAbono via the Notification API. Use when you need to retrieve webhook notification history with optional filtering by business, segment, date range, state, or webhook ID. Returns paginated results with notification details including sending status and related resources.
Parámetros de entrada
IdSegmentintegerFilter by specific segment identifier to retrieve notifications for a particular segment only
IdWebhookintegerFilter by webhook identifier to retrieve notifications for a specific webhook only
StateLifestringFilter by specific state of the webhook notification (e.g., 'Ok', 'Failed')
IdBusinessintegerObligatorioYour business identifier. Required to retrieve webhook notifications for a specific business.
DateUpdateMaxstringNotifications updated before this date in ISO 8601 format. Use to filter by maximum update date.
DateUpdateMinstringNotifications updated after this date in ISO 8601 format. Use to filter by minimum update date.
DateCreationMaxstringNotifications created before this date in ISO 8601 format (e.g., '2025-12-31T23:59:59'). Use to filter by maximum creation date.
DateCreationMinstringNotifications created after this date in ISO 8601 format (e.g., '2025-07-27T13:54:00'). Use to filter by minimum creation date.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List WebhooksPROABONO_LIST_WEBHOOKSAcciónTool 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.
PROABONO_LIST_WEBHOOKSAcciónTool 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.
Parámetros de entrada
StateLifestringFilter webhooks by state. Common values include 'Ok' for active webhooks and 'DisabledUser' for disabled webhooks.
IdBusinessintegerObligatorioYour business identifier. This is a required parameter to identify which business's webhooks to retrieve.
DateUpdateMaxstringFilter webhooks updated before a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T23:59:59').
DateUpdateMinstringFilter webhooks updated after a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').
DateCreationMaxstringFilter webhooks created before a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').
DateCreationMinstringFilter webhooks created after a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Quote Balance Line CreationPROABONO_QUOTE_BALANCE_LINEAcciónTool to get a pricing quote for creating a balance line (one-time charge or credit). Use when you need to calculate the total amount including taxes before creating a balance line for a customer.
PROABONO_QUOTE_BALANCE_LINEAcciónTool to get a pricing quote for creating a balance line (one-time charge or credit). Use when you need to calculate the total amount including taxes before creating a balance line for a customer.
Parámetros de entrada
LabelstringObligatorioDescription or label for the balance line item. This will appear on invoices and billing statements.
AmountintegerObligatorioAmount in the smallest currency unit (e.g., cents for USD, pennies for GBP). For example, $15.00 would be 1500.
EnsureBillablebooleanIf true (default), validates that the customer has valid payment information configured. The quote endpoint requires valid payment settings regardless of this parameter value.
ReferenceCustomerstringObligatorioThe unique reference of the customer for whom to calculate the balance line pricing. This is the customer identifier shared between your application and ProAbono.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Revoke Customer Portal LinksPROABONO_REVOKE_CUSTOMER_LINKSAcciónTool to revoke encrypted customer portal links and generate new ones in ProAbono. Use when you need to invalidate previously generated customer portal links for security purposes (e.g., after a potential link compromise or as part of security best practices).
PROABONO_REVOKE_CUSTOMER_LINKSAcciónTool to revoke encrypted customer portal links and generate new ones in ProAbono. Use when you need to invalidate previously generated customer portal links for security purposes (e.g., after a potential link compromise or as part of security best practices).
Parámetros de entrada
reference_customerstringObligatorioThe unique reference identifier of the customer whose portal links should be revoked
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Business Billing AddressPROABONO_UPDATE_BUSINESSES_BILLING_ADDRESSAcciónTool 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.
PROABONO_UPDATE_BUSINESSES_BILLING_ADDRESSAcciónTool 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.
Parámetros de entrada
IdintegerObligatorioBusiness identifier whose billing address to update
CitystringCity name
PhonestringContact phone number
RegionstringRegion stands for Subdivision, Department, Region, Province, State. Note: Region field may have business rule restrictions preventing updates.
CompanystringName of the company billing customers
CountrystringTwo-letter country code per ISO 3166-1 alpha-2. Note: Country field may have business rule restrictions preventing updates.
ZipCodestringPostal code
LastNamestringIndividual name or department contact
FirstNamestringIndividual name or department contact
AddressLine1stringPrimary address line
AddressLine2stringSecondary address line (floor, suite, building, etc.)
TaxInformationstringVAT/TAX identification number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CustomerPROABONO_UPDATE_CUSTOMERAcciónTool 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.
PROABONO_UPDATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
IdintegerObligatorioThe unique identifier of the customer to update
NamestringDisplay name of the customer. Use this to update the customer's full name
EmailstringCustomer's email address. Use this to update the customer's contact email
LanguagestringCustomer's preferred language in ISO 639-1 format (2-letter code). Use this to update the customer's language preference
IdBusinessintegerThe business identifier. Optional parameter to scope the request to a specific business
ReferenceCustomerstringYour custom reference for the customer shared between ProAbono and your application
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Customer Billing AddressPROABONO_UPDATE_CUSTOMER_BILLING_ADDRESSAcciónTool 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.
PROABONO_UPDATE_CUSTOMER_BILLING_ADDRESSAcciónTool 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.
Parámetros de entrada
CitystringCity name of the billing address
PhonestringPhone number for the billing address
RegionstringISO 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.
CompanystringName of the company for billing purposes
CountrystringISO 3166-1 alpha-2 country code of the billing address (e.g., FR for France, US for United States)
ZipCodestringPostal code or ZIP code of the billing address
LastNamestringLast name of the billing address holder
FirstNamestringFirst name of the billing address holder
AddressLine1stringPrimary address line of the billing address
AddressLine2stringSecondary address line (optional, for apartment, suite, etc.)
TaxInformationstringTax information such as VAT ID, Num TVA Intra, GST, or other tax identification number
reference_customerstringObligatorioThe unique reference of the customer whose billing address to update. This is the shared identifier between ProAbono and your application.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Customer Payment SettingsPROABONO_UPDATE_CUSTOMER_PAYMENT_SETTINGSAcciónTool to update payment settings for a specific customer in ProAbono. Use when you need to set a customer's payment method preference or update their billing configuration.
PROABONO_UPDATE_CUSTOMER_PAYMENT_SETTINGSAcciónTool to update payment settings for a specific customer in ProAbono. Use when you need to set a customer's payment method preference or update their billing configuration.
Parámetros de entrada
TypePaymentstringThe manual payment method type to set. Possible values: Card, ExternalBank, ExternalCash, ExternalCheck, ExternalOther. When set, payment collection becomes your responsibility
ReferenceCustomerstringObligatorioThe unique reference identifier of the customer whose payment settings you want to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Customer Shipping AddressPROABONO_UPDATE_CUSTOMER_SHIPPINGAcciónTool 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.
PROABONO_UPDATE_CUSTOMER_SHIPPINGAcciónTool 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.
Parámetros de entrada
IdintegerObligatorioThe customer ID whose shipping address to update
CitystringCity name
PhonestringPhone number
RegionstringISO 3166-2 region/province code
CompanystringCompany name
CountrystringISO 3166-1 alpha-2 country code
ZipCodestringPostal code
LastNamestringLast name
FirstNamestringFirst name
IdBusinessintegerObligatorioYour Business ID
AddressLine1stringPrimary address line
AddressLine2stringSecondary address line
TaxInformationstringVAT ID or tax identifier
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update FeaturePROABONO_UPDATE_FEATUREAcciónTool 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.
PROABONO_UPDATE_FEATUREAcciónTool 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.
Parámetros de entrada
idintegerObligatorioID of the feature to update
NamestringThe feature name displayed to users
OrderintegerDisplay position among other features (lower numbers appear first)
IsVisiblebooleanWhether to show this feature in offers and hosted pages
IdBusinessintegerYour Business identifier
TypeFeaturestringenumFeature type enumeration.
OnOffLimitationConsumptionReferenceFeaturestringShared key between ProAbono and your system for identifying this feature
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Tax ProfilesPROABONO_UPDATE_TAX_PROFILESAcciónTool 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.
PROABONO_UPDATE_TAX_PROFILESAcciónTool 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.
Parámetros de entrada
IdintegerObligatorioThe ID of the tax profile to update
NamestringName of the tax profile to update
LabelstringDisplay label for the tax (maximum 10 characters)
IdBusinessintegerObligatorioThe ID of the business
DescriptionstringDescription of the tax profile to provide additional context
RateDefaultintegerDefault tax rate in basis points (e.g., 2500 for 25%, 2000 for 20%). Must be a non-negative integer
TypeRateTaxstringType of tax rate applied (e.g., 'Standard', 'Reduced', 'Outside', 'Zero')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not