The ProAbono connector lets your AI agent act in each user's ProAbono account. Each user connects their own ProAbono API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 41 tools.
- Tools
- 41
- What they doRead · write · destructive
- 22 · 15 · 422 read15 write4 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ProAbono connection
In AgentKit > Connections, create a ProAbono connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolproabono_balance_line_quotePreview the effect of adding a balance line (one-off charge or credit) to a customer.Read-onlyQuote Balance Line
Preview the effect of adding a balance line (one-off charge or credit) to a customer. Use proabono_balance_line_create to add it.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
amountinteger- Amount in cents, before taxes. Example: 50000
ensure_billableboolean- Require payment info. Example: true
htmlboolean- HTML amounts. Example: true
id_customerinteger- Customer ID. Example: 133700
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
labelstring- Invoice line label. Example: Consulting (hours)
quantityinteger- Informative quantity. Example: 18
proabono_balance_lines_listList balance lines by segment, feature, customer or subscription; the total is in Computations.Read-onlyList Balance Lines
List balance lines by segment, feature, customer or subscription; the total is in Computations. Set size_page 0 to get only the total.
Inputs
id_customerinteger- Customer ID. Example: 133700
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
pageinteger- Page number, starting at 1. Example: 1
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_featurestring- Feature. Example: feat-users
reference_segmentstring- Segment. Example: demo-eur
size_pageinteger- Number of records per page. Example: 20
proabono_billing_address_getGet a customer's billing address.Read-onlyGet Billing Address
Get a customer's billing address. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_customer_getGet a customer by its ReferenceCustomer, with its status and hosted portal links.Read-onlyGet Customer
Get a customer by its ReferenceCustomer, with its status and hosted portal links. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_offerstring- Offer for a subscribe link. Example: offer-premium
proabono_customers_listList customers, optionally by segment or by a feature in their active subscriptions, with paging.Read-onlyList Customers
List customers, optionally by segment or by a feature in their active subscriptions, with paging. Use proabono_customer_get for one customer.
Inputs
pageinteger- Page number, starting at 1. Example: 1
reference_featurestring- Only customers with an active subscription containing this feature. Example: feat-users
reference_segmentstring- Segment reference. Example: demo-eur
size_pageinteger- Number of records per page. Example: 20
proabono_feature_getGet one feature by its reference.Read-onlyGet Feature
Get one feature by its reference. Get feature references from proabono_features_list.
Inputs
reference_featurestringrequired- Feature reference. Example: feat-users
languagestring- Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: enone of
deenesfrnlptit reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_segmentstring- Segment reference. Example: demo-eur
proabono_features_listList the features defined in a segment.Read-onlyList Features
List the features defined in a segment. Use proabono_feature_get for one feature.
Inputs
is_visibleboolean- Visible only. Example: true
languagestring- Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: enone of
deenesfrnlptit pageinteger- Page number, starting at 1. Example: 1
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_segmentstring- Segment reference. Example: demo-eur
size_pageinteger- Number of records per page. Example: 20
proabono_invoice_getGet one invoice by ID with lines, totals and status.Read-onlyGet Invoice
Get one invoice by ID with lines, totals and status. Get invoice IDs from proabono_invoices_list.
Inputs
id_invoiceintegerrequired- Invoice ID. Example: 549013
proabono_invoice_get_by_numberGet one invoice by its full number.Read-onlyGet Invoice by Number
Get one invoice by its full number. Use proabono_invoice_get when you have the ID.
Inputs
full_numberstringrequired- Invoice full number. Example: INV-2026-0042
proabono_invoices_listList invoices, by customer or subscription, with paging.Read-onlyList Invoices
List invoices, by customer or subscription, with paging. Use proabono_invoice_get for one invoice.
Inputs
id_customerinteger- Customer ID. Example: 133700
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
pageinteger- Page number, starting at 1. Example: 1
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
size_pageinteger- Number of records per page. Example: 20
proabono_offer_getGet one offer with its pricing, features and links.Read-onlyGet Offer
Get one offer with its pricing, features and links. Get offer references from proabono_offers_list.
Inputs
reference_offerstringrequired- Offer reference. Example: offer-premium
htmlboolean- HTML pricing text. Example: true
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
ignore_featuresboolean- Leave out features. Example: true
is_visibleboolean- Visible offers only (true) or hidden only (false). Example: true
languagestring- Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: enone of
deenesfrnlptit linksboolean- Include links. Example: true
prefix_reference_offerstring- Offer reference prefix. Example: offer-
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_pricing_tablestring- Pricing table reference. Example: main-pricing
reference_segmentstring- Segment reference. Example: demo-eur
upgradeboolean- Return upgrade offers for the customer. Example: true
proabono_offers_listList offers (plans), optionally the ones available to a customer or for upgrading a subscription, with hosted subscribe links.Read-onlyList Offers
List offers (plans), optionally the ones available to a customer or for upgrading a subscription, with hosted subscribe links. Use proabono_offer_get for one offer.
Inputs
htmlboolean- HTML pricing text. Example: true
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
ignore_featuresboolean- Leave out features. Example: true
is_visibleboolean- Visible offers only (true) or hidden only (false). Example: true
languagestring- Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: enone of
deenesfrnlptit linksboolean- Include links. Example: true
pageinteger- Page number, starting at 1. Example: 1
prefix_reference_offerstring- Offer reference prefix. Example: offer-
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_pricing_tablestring- Pricing table reference. Example: main-pricing
reference_segmentstring- Segment reference. Example: demo-eur
size_pageinteger- Number of records per page. Example: 20
upgradeboolean- Return upgrade offers for the customer. Example: true
proabono_payment_settings_getGet a customer's payment settings (billing mode, payment type, next billing date).Read-onlyGet Payment Settings
Get a customer's payment settings (billing mode, payment type, next billing date). Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_subscription_getGet one subscription by ID with status, dates, pricing and features.Read-onlyGet Subscription
Get one subscription by ID with status, dates, pricing and features. Get subscription IDs from proabono_subscriptions_list.
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
ignore_featuresboolean- Leave out features. Example: true
proabono_subscription_get_by_customerGet a customer's active subscription by ReferenceCustomer.Read-onlyGet Customer Subscription
Get a customer's active subscription by ReferenceCustomer. Use proabono_subscription_get when you have the subscription ID.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
ignore_featuresboolean- Leave out features. Example: true
reference_offerstring- Offer for an upgrade link. Example: offer-premium
proabono_subscription_quotePreview the price of creating a subscription (with optional overrides) without creating it.Read-onlyQuote Subscription
Preview the price of creating a subscription (with optional overrides) without creating it. Use proabono_subscription_create to create it.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_offerstringrequired- Offer reference. Example: offer-premium
amount_recurrenceinteger- Recurring amount in cents. Example: 4900
amount_terminationinteger- Termination fee in cents. Example: 0
amount_trialinteger- Trial amount in cents. Example: 0
amount_up_frontinteger- Up-front amount in cents. Example: 0
bill_nowboolean- Bill the start now. Example: true
count_min_recurrencesinteger- Minimum committed recurrences. Example: 3
count_recurrencesinteger- Number of recurrences. Example: 12
date_startstring- Start date. Example: 2026-12-01T00:00:00Z
description_localizedstring- Description. Example: Custom premium plan
discountsarray- Discounts to apply, as a JSON array of objects with their references. Example: [{"ReferenceDiscount": "welcome-10"}]
duration_recurrenceinteger- Recurrence length. Example: 1
duration_trialinteger- Trial duration. Example: 14
ensure_billableboolean- Require valid payment info. Example: true
htmlboolean- HTML-formatted amounts. Example: true
metadataobject- Up to 5 custom key/value pairs (keys up to 50 characters, values up to 450). An empty value unsets a key. Example: {"plan_source": "website"}
reference_customer_buyerstring- Paying customer reference. Example: cust-42
title_localizedstring- Title. Example: Premium (custom)
try_startboolean- Try to start immediately. Example: true
unit_recurrencestring- Recurrence unit. One of: Day, Week, Month, Year. Example: Monthone of
DayWeekMonthYear unit_trialstring- Trial unit. One of: Day, Week, Month, Year. Example: Dayone of
DayWeekMonthYear
proabono_subscription_start_quotePreview the charge for starting a subscription.Read-onlyQuote Subscription Start
Preview the charge for starting a subscription. Get subscription IDs from proabono_subscriptions_list.
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
bill_nowboolean- Bill now. Example: true
ensure_billableboolean- Require payment info. Example: true
htmlboolean- HTML-formatted amounts. Example: true
proabono_subscription_upgrade_quotePreview the charge for upgrading a subscription to another offer.Read-onlyQuote Subscription Upgrade
Preview the charge for upgrading a subscription to another offer. Get subscription IDs from proabono_subscriptions_list.
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
reference_offerstringrequired- Target offer. Example: offer-premium
bill_nowboolean- Bill now. Example: true
htmlboolean- HTML-formatted amounts. Example: true
ignore_engagementboolean- Ignore minimum commitment. Example: true
immediateboolean- Upgrade now (true) or at term end (false). Example: true
proabono_subscriptions_listList subscriptions, by segment, customer or buyer, with paging.Read-onlyList Subscriptions
List subscriptions, by segment, customer or buyer, with paging. Use proabono_subscription_get for one subscription.
Inputs
ignore_featuresboolean- Leave out features. Example: true
pageinteger- Page number, starting at 1. Example: 1
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_customer_buyerstring- Buyer reference. Example: cust-42
reference_segmentstring- Segment. Example: demo-eur
size_pageinteger- Number of records per page. Example: 20
proabono_usage_getGet one customer's usage of a feature: whether it is included or enabled, and included and current quantities.Read-onlyGet Usage
Get one customer's usage of a feature: whether it is included or enabled, and included and current quantities. Use this to enforce access and quotas in your app.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_featurestringrequired- Feature reference. Example: feat-users
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
proabono_usage_update_quotePreview the charge of a usage change (increment, quantity or on/off) without applying it.Read-onlyQuote Usage Update
Preview the charge of a usage change (increment, quantity or on/off) without applying it. Use the usage tools to apply it.
Inputs
date_stampstringrequired- Timestamp of the change (ISO 8601). It is the idempotency key: updates with the same timestamp are recorded once. Example: 2026-11-17T10:00:00Z
reference_featurestringrequired- Feature reference. Example: feat-users
ensure_billableboolean- Require payment info. Example: true
htmlboolean- HTML amounts. Example: true
id_subscriptioninteger- Subscription ID. Required unless reference_customer is given. Example: 10725
incrementinteger- Quantity to add (negative to subtract). Example: 1
is_enabledboolean- Enable or disable an OnOff feature. Example: true
next_termboolean- Quote for the next term. Example: true
quantity_currentinteger- New current quantity. Example: 5
reference_customerstring- Your reference for the customer. Required unless id_subscription is given. Example: cust-42
proabono_usages_listList feature usages, by customer, subscription or feature.Read-onlyList Usages
List feature usages, by customer, subscription or feature. Use proabono_usage_get for one customer and feature.
Inputs
id_customerinteger- Customer ID. Example: 133700
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
reference_customerstring- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_featurestring- Feature reference. Example: feat-users
proabono_balance_line_createAdd a one-off charge (positive amount) or credit (negative amount) to a customer's balance, billed on the next invoice.WriteCreate Balance Line
Add a one-off charge (positive amount) or credit (negative amount) to a customer's balance, billed on the next invoice. Use proabono_customer_bill to invoice now.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
amountinteger- Amount in cents, before taxes. Example: 50000
ensure_billableboolean- Require payment info. Example: true
id_customerinteger- Customer ID. Example: 133700
id_subscriptioninteger- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
labelstring- Invoice line label. Example: Consulting (hours)
quantityinteger- Informative quantity. Example: 18
proabono_billing_address_updateSet a customer's billing address (company, name, address, country, region, phone, tax number).WriteUpdate Billing Address
Set a customer's billing address (company, name, address, country, region, phone, tax number). Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
address_line1string- Address line 1. Example: 123 avenue des Champs Elysees
address_line2string- Address line 2. Example: 1st Floor
citystring- City. Example: Paris
companystring- Company name. Example: John Doe LLC
countrystring- ISO country code. Example: FR
first_namestring- First name. Example: John
last_namestring- Last name. Example: Doe
phonestring- Phone. Example: +33102030405
regionstring- ISO 3166-2 region code. Example: FR-75
tax_informationstring- Tax/VAT number. Example: FR1234567890
zip_codestring- Postal code. Example: 75008
proabono_customer_billInvoice a customer now for their pending balance lines, optionally for a date window and with a note.WriteBill Customer
Invoice a customer now for their pending balance lines, optionally for a date window and with a note. This issues a real invoice.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
date_endstring- Ignore after. Example: 2026-12-31T23:59:59Z
date_startstring- Ignore before. Example: 2026-12-01T00:00:00Z
ensure_billableboolean- Require payment info. Example: true
force_offlineboolean- Force an offline invoice. Example: true
note_localizedstring- Invoice note. Example: Payment due within 30 days.
proabono_customer_links_revokeRevoke all encrypted customer portal links of a customer.WriteRevoke Customer Portal Links
Revoke all encrypted customer portal links of a customer. Get fresh links with proabono_customer_get. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_customer_upsertCreate a customer, or update the existing one with the same ReferenceCustomer; returns hosted portal links.WriteCreate or Update Customer
Create a customer, or update the existing one with the same ReferenceCustomer; returns hosted portal links. Use proabono_customer_get to read a customer without changing it.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
emailstring- Email. Example: john@doe.com
languagestring- Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: enone of
deenesfrnlptit metadataobject- Up to 5 custom key/value pairs (keys up to 50 characters, values up to 450). An empty value unsets a key. Example: {"plan_source": "website"}
namestring- Full name. Example: John Doe
reference_affiliationstring- Affiliate reference. Example: janesmith
reference_offerstring- Offer the customer wants to subscribe to. Example: offer-premium
reference_segmentstring- Segment reference (needed with more than one segment). Example: demo-eur
proabono_payment_settings_updateUpdate a customer's payment settings: billing mode, manual payment type, invoice note or next billing date.WriteUpdate Payment Settings
Update a customer's payment settings: billing mode, manual payment type, invoice note or next billing date. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
date_next_billingstring- Next billing date. Example: 2026-12-01T00:00:00Z
is_grey_listedboolean- Block access to payment forms. Example: true
mode_billingstring- How the customer is billed (billing mode), as defined in ProAbono. Example: Automated
note_invoicestring- Note added to upcoming invoices. Example: Thank you for your business.
type_paymentstring- Manual payment method. One of: ExternalBank, ExternalCash, ExternalCheck, ExternalOther. Example: ExternalBankone of
ExternalBankExternalCashExternalCheckExternalOther
proabono_subscription_createSubscribe a customer to an offer, optionally overriding trial, pricing, recurrence, start date or discounts.WriteCreate Subscription
Subscribe a customer to an offer, optionally overriding trial, pricing, recurrence, start date or discounts. Use proabono_subscription_quote first to preview the price. Set migration true to import an existing subscription.
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
reference_offerstringrequired- Offer reference. Example: offer-premium
amount_recurrenceinteger- Recurring amount in cents. Example: 4900
amount_terminationinteger- Termination fee in cents. Example: 0
amount_trialinteger- Trial amount in cents. Example: 0
amount_up_frontinteger- Up-front amount in cents. Example: 0
bill_nowboolean- Bill the start now. Example: true
count_min_recurrencesinteger- Minimum committed recurrences. Example: 3
count_recurrencesinteger- Number of recurrences. Example: 12
date_startstring- Start date. Example: 2026-12-01T00:00:00Z
description_localizedstring- Description. Example: Custom premium plan
discountsarray- Discounts to apply, as a JSON array of objects with their references. Example: [{"ReferenceDiscount": "welcome-10"}]
duration_recurrenceinteger- Recurrence length. Example: 1
duration_trialinteger- Trial duration. Example: 14
ensure_billableboolean- Require valid payment info. Example: true
metadataobject- Up to 5 custom key/value pairs (keys up to 50 characters, values up to 450). An empty value unsets a key. Example: {"plan_source": "website"}
migrationboolean- Migrate an existing subscription without billing. Example: true
reference_customer_buyerstring- Paying customer reference. Example: cust-42
title_localizedstring- Title. Example: Premium (custom)
try_startboolean- Try to start immediately. Example: true
unit_recurrencestring- Recurrence unit. One of: Day, Week, Month, Year. Example: Monthone of
DayWeekMonthYear unit_trialstring- Trial unit. One of: Day, Week, Month, Year. Example: Dayone of
DayWeekMonthYear
proabono_subscription_startStart (or restart) a subscription, optionally billing now.WriteStart Subscription
Start (or restart) a subscription, optionally billing now. Use proabono_subscription_start_quote to preview the charge. Get subscription IDs from proabono_subscriptions_list.
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
bill_nowboolean- Bill now. Example: true
ensure_billableboolean- Require payment info. Example: true
proabono_subscription_suspendSuspend a subscription.WriteSuspend Subscription
Suspend a subscription. Use proabono_subscription_start to resume it. Get subscription IDs from proabono_subscriptions_list.
- Idempotent
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
proabono_subscription_term_date_updateChange the term (end of current period) date of a subscription.WriteUpdate Subscription Term Date
Change the term (end of current period) date of a subscription. Get subscription IDs from proabono_subscriptions_list.
- Idempotent
Inputs
date_termstringrequired- New term date. Example: 2026-12-31T23:59:59Z
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
proabono_subscription_upgradeMove a subscription to another offer, now or at the end of the term.WriteUpgrade Subscription
Move a subscription to another offer, now or at the end of the term. Use proabono_subscription_upgrade_quote to preview the charge. Get subscription IDs from proabono_subscriptions_list.
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
reference_offerstringrequired- Target offer. Example: offer-premium
bill_nowboolean- Bill now. Example: true
ignore_engagementboolean- Ignore minimum commitment. Example: true
immediateboolean- Upgrade now (true) or at term end (false). Example: true
proabono_usage_feature_toggleEnable or disable an OnOff feature for a customer.WriteEnable or Disable Feature
Enable or disable an OnOff feature for a customer. Give reference_customer or id_subscription.
- Idempotent
Inputs
date_stampstringrequired- Timestamp of the change (ISO 8601). It is the idempotency key: updates with the same timestamp are recorded once. Example: 2026-11-17T10:00:00Z
is_enabledbooleanrequired- Enable or disable an OnOff feature. Example: true
reference_featurestringrequired- Feature reference. Example: feat-users
id_subscriptioninteger- Subscription ID. Required unless reference_customer is given. Example: 10725
reference_customerstring- Your reference for the customer. Required unless id_subscription is given. Example: cust-42
proabono_usage_incrementAdd to (or subtract from) a customer's usage of a Limitation or Consumption feature.WriteIncrement Usage
Add to (or subtract from) a customer's usage of a Limitation or Consumption feature. Use proabono_usage_quantity_set to set an absolute value.
Inputs
date_stampstringrequired- Timestamp of the change (ISO 8601). It is the idempotency key: updates with the same timestamp are recorded once. Example: 2026-11-17T10:00:00Z
incrementintegerrequired- Quantity to add (negative to subtract). Example: 1
reference_featurestringrequired- Feature reference. Example: feat-users
id_subscriptioninteger- Subscription ID. Required unless reference_customer is given. Example: 10725
reference_customerstring- Your reference for the customer. Required unless id_subscription is given. Example: cust-42
proabono_usage_quantity_setSet the current quantity of a customer's Limitation or Consumption feature.WriteSet Usage Quantity
Set the current quantity of a customer's Limitation or Consumption feature. Use proabono_usage_increment to add a delta.
- Idempotent
Inputs
date_stampstringrequired- Timestamp of the change (ISO 8601). It is the idempotency key: updates with the same timestamp are recorded once. Example: 2026-11-17T10:00:00Z
quantity_currentintegerrequired- New current quantity. Example: 5
reference_featurestringrequired- Feature reference. Example: feat-users
id_subscriptioninteger- Subscription ID. Required unless reference_customer is given. Example: 10725
reference_customerstring- Your reference for the customer. Required unless id_subscription is given. Example: cust-42
proabono_usages_bulk_updateUpdate several usages in one call (increments, quantities or on/off).WriteUpdate Multiple Usages
Update several usages in one call (increments, quantities or on/off). Use the single-usage tools for one change.
Inputs
usagesarrayrequired- Usage updates as a JSON array; each needs ReferenceFeature, ReferenceCustomer (or IdSubscription), DateStamp and one of Increment, QuantityCurrent or IsEnabled. Example: [{"ReferenceFeature": "feat-text-messages", "ReferenceCustomer": "cust-42", "Increment": 57, "DateStamp": "2026-11-17T10:00:00Z"}]
proabono_customer_anonymizeAnonymize a customer's personal data (GDPR).DestructiveAnonymize Customer
Anonymize a customer's personal data (GDPR). This cannot be undone. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_customer_invalidateInvalidate a customer so its ReferenceCustomer can be reused; subscriptions and invoices are kept.DestructiveInvalidate Customer
Invalidate a customer so its ReferenceCustomer can be reused; subscriptions and invoices are kept. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_customer_suspendSuspend a customer (fraud or permanent leave): no portal, emails, usage or subscription processing.DestructiveSuspend Customer
Suspend a customer (fraud or permanent leave): no portal, emails, usage or subscription processing. Prefer terminating subscriptions with proabono_subscription_terminate. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.
- Idempotent
Inputs
reference_customerstringrequired- Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
proabono_subscription_terminateTerminate a subscription at renewal, immediately or on a chosen date.DestructiveTerminate Subscription
Terminate a subscription at renewal, immediately or on a chosen date. Get subscription IDs from proabono_subscriptions_list.
- Idempotent
Inputs
id_subscriptionintegerrequired- ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
date_terminationstring- Termination date. Example: 2026-12-31T23:59:59Z
immediateboolean- Terminate now instead of at renewal. Example: true
No tools match.