> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ProAbono

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.

**Authentication:** Agent Key + API Key
**Categories:** Accounting & Finance, Project Management
**Tools:** 41: 22 read, 15 write, 4 destructive
**Users sign in with:** Username and password
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=PROABONO)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ProAbono connection

   In **AgentKit > Connections**, create a ProAbono connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'proabono_balance_line_quote',
  toolInput: {
    reference_customer: '<reference_customer>',
  },
  connector: 'proabono',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="proabono_balance_line_quote",
    tool_input={
        "reference_customer": "<reference_customer>",
    },
    connection_name="proabono",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `proabono_balance_line_quote`

Quote Balance Line · Read-only

Preview the effect of adding a balance line (one-off charge or credit) to a customer.
Use proabono_balance_line_create to add it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `amount` (`integer`, optional): Amount in cents, before taxes. Example: 50000
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true
- `html` (`boolean`, optional): HTML amounts. Example: true
- `id_customer` (`integer`, optional): Customer ID. Example: 133700
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `label` (`string`, optional): Invoice line label. Example: Consulting (hours)
- `quantity` (`integer`, optional): Informative quantity. Example: 18

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_balance_lines_list`

List Balance Lines · Read-only

List balance lines by segment, feature, customer or subscription; the total is in Computations.
Set size_page 0 to get only the total.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_customer` (`integer`, optional): Customer ID. Example: 133700
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_feature` (`string`, optional): Feature. Example: feat-users
- `reference_segment` (`string`, optional): Segment. Example: demo-eur
- `size_page` (`integer`, optional): Number of records per page. Example: 20

Example input: `{}`

### `proabono_billing_address_get`

Get Billing Address · Read-only

Get a customer's billing address.
Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_get`

Get Customer · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_offer` (`string`, optional): Offer for a subscribe link. Example: offer-premium

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customers_list`

List Customers · Read-only

List customers, optionally by segment or by a feature in their active subscriptions, with paging.
Use proabono_customer_get for one customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `reference_feature` (`string`, optional): Only customers with an active subscription containing this feature. Example: feat-users
- `reference_segment` (`string`, optional): Segment reference. Example: demo-eur
- `size_page` (`integer`, optional): Number of records per page. Example: 20

Example input: `{}`

### `proabono_feature_get`

Get Feature · Read-only

Get one feature by its reference.
Get feature references from proabono_features_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_feature` (`string`, required): Feature reference. Example: feat-users
- `language` (`string`, optional): Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: en. One of: `de`, `en`, `es`, `fr`, `nl`, `pt`, `it`.
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_segment` (`string`, optional): Segment reference. Example: demo-eur

Example input: `{"reference_feature":"<reference_feature>"}`

### `proabono_features_list`

List Features · Read-only

List the features defined in a segment.
Use proabono_feature_get for one feature.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `is_visible` (`boolean`, optional): Visible only. Example: true
- `language` (`string`, optional): Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: en. One of: `de`, `en`, `es`, `fr`, `nl`, `pt`, `it`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_segment` (`string`, optional): Segment reference. Example: demo-eur
- `size_page` (`integer`, optional): Number of records per page. Example: 20

Example input: `{}`

### `proabono_invoice_get`

Get Invoice · Read-only

Get one invoice by ID with lines, totals and status.
Get invoice IDs from proabono_invoices_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_invoice` (`integer`, required): Invoice ID. Example: 549013

Example input: `{"id_invoice":549013}`

### `proabono_invoice_get_by_number`

Get Invoice by Number · Read-only

Get one invoice by its full number.
Use proabono_invoice_get when you have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `full_number` (`string`, required): Invoice full number. Example: INV-2026-0042

Example input: `{"full_number":"<full_number>"}`

### `proabono_invoices_list`

List Invoices · Read-only

List invoices, by customer or subscription, with paging.
Use proabono_invoice_get for one invoice.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_customer` (`integer`, optional): Customer ID. Example: 133700
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `size_page` (`integer`, optional): Number of records per page. Example: 20

Example input: `{}`

### `proabono_offer_get`

Get Offer · Read-only

Get one offer with its pricing, features and links.
Get offer references from proabono_offers_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_offer` (`string`, required): Offer reference. Example: offer-premium
- `html` (`boolean`, optional): HTML pricing text. Example: true
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `ignore_features` (`boolean`, optional): Leave out features. Example: true
- `is_visible` (`boolean`, optional): Visible offers only (true) or hidden only (false). Example: true
- `language` (`string`, optional): Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: en. One of: `de`, `en`, `es`, `fr`, `nl`, `pt`, `it`.
- `links` (`boolean`, optional): Include links. Example: true
- `prefix_reference_offer` (`string`, optional): Offer reference prefix. Example: offer-
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_pricing_table` (`string`, optional): Pricing table reference. Example: main-pricing
- `reference_segment` (`string`, optional): Segment reference. Example: demo-eur
- `upgrade` (`boolean`, optional): Return upgrade offers for the customer. Example: true

Example input: `{"reference_offer":"<reference_offer>"}`

### `proabono_offers_list`

List Offers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `html` (`boolean`, optional): HTML pricing text. Example: true
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `ignore_features` (`boolean`, optional): Leave out features. Example: true
- `is_visible` (`boolean`, optional): Visible offers only (true) or hidden only (false). Example: true
- `language` (`string`, optional): Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: en. One of: `de`, `en`, `es`, `fr`, `nl`, `pt`, `it`.
- `links` (`boolean`, optional): Include links. Example: true
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `prefix_reference_offer` (`string`, optional): Offer reference prefix. Example: offer-
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_pricing_table` (`string`, optional): Pricing table reference. Example: main-pricing
- `reference_segment` (`string`, optional): Segment reference. Example: demo-eur
- `size_page` (`integer`, optional): Number of records per page. Example: 20
- `upgrade` (`boolean`, optional): Return upgrade offers for the customer. Example: true

Example input: `{}`

### `proabono_payment_settings_get`

Get Payment Settings · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_subscription_get`

Get Subscription · Read-only

Get one subscription by ID with status, dates, pricing and features.
Get subscription IDs from proabono_subscriptions_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `ignore_features` (`boolean`, optional): Leave out features. Example: true

Example input: `{"id_subscription":10725}`

### `proabono_subscription_get_by_customer`

Get Customer Subscription · Read-only

Get a customer's active subscription by ReferenceCustomer.
Use proabono_subscription_get when you have the subscription ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `ignore_features` (`boolean`, optional): Leave out features. Example: true
- `reference_offer` (`string`, optional): Offer for an upgrade link. Example: offer-premium

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_subscription_quote`

Quote Subscription · Read-only

Preview the price of creating a subscription (with optional overrides) without creating it.
Use proabono_subscription_create to create it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_offer` (`string`, required): Offer reference. Example: offer-premium
- `amount_recurrence` (`integer`, optional): Recurring amount in cents. Example: 4900
- `amount_termination` (`integer`, optional): Termination fee in cents. Example: 0
- `amount_trial` (`integer`, optional): Trial amount in cents. Example: 0
- `amount_up_front` (`integer`, optional): Up-front amount in cents. Example: 0
- `bill_now` (`boolean`, optional): Bill the start now. Example: true
- `count_min_recurrences` (`integer`, optional): Minimum committed recurrences. Example: 3
- `count_recurrences` (`integer`, optional): Number of recurrences. Example: 12
- `date_start` (`string`, optional): Start date. Example: 2026-12-01T00:00:00Z
- `description_localized` (`string`, optional): Description. Example: Custom premium plan
- `discounts` (`array`, optional): Discounts to apply, as a JSON array of objects with their references. Example: [{"ReferenceDiscount": "welcome-10"}]
- `duration_recurrence` (`integer`, optional): Recurrence length. Example: 1
- `duration_trial` (`integer`, optional): Trial duration. Example: 14
- `ensure_billable` (`boolean`, optional): Require valid payment info. Example: true
- `html` (`boolean`, optional): HTML-formatted amounts. Example: true
- `metadata` (`object`, optional): 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_buyer` (`string`, optional): Paying customer reference. Example: cust-42
- `title_localized` (`string`, optional): Title. Example: Premium (custom)
- `try_start` (`boolean`, optional): Try to start immediately. Example: true
- `unit_recurrence` (`string`, optional): Recurrence unit. One of: Day, Week, Month, Year. Example: Month. One of: `Day`, `Week`, `Month`, `Year`.
- `unit_trial` (`string`, optional): Trial unit. One of: Day, Week, Month, Year. Example: Day. One of: `Day`, `Week`, `Month`, `Year`.

Example input: `{"reference_customer":"<reference_customer>","reference_offer":"<reference_offer>"}`

### `proabono_subscription_start_quote`

Quote Subscription Start · Read-only

Preview the charge for starting a subscription.
Get subscription IDs from proabono_subscriptions_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `bill_now` (`boolean`, optional): Bill now. Example: true
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true
- `html` (`boolean`, optional): HTML-formatted amounts. Example: true

Example input: `{"id_subscription":10725}`

### `proabono_subscription_upgrade_quote`

Quote Subscription Upgrade · Read-only

Preview the charge for upgrading a subscription to another offer.
Get subscription IDs from proabono_subscriptions_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `reference_offer` (`string`, required): Target offer. Example: offer-premium
- `bill_now` (`boolean`, optional): Bill now. Example: true
- `html` (`boolean`, optional): HTML-formatted amounts. Example: true
- `ignore_engagement` (`boolean`, optional): Ignore minimum commitment. Example: true
- `immediate` (`boolean`, optional): Upgrade now (true) or at term end (false). Example: true

Example input: `{"id_subscription":10725,"reference_offer":"<reference_offer>"}`

### `proabono_subscriptions_list`

List Subscriptions · Read-only

List subscriptions, by segment, customer or buyer, with paging.
Use proabono_subscription_get for one subscription.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ignore_features` (`boolean`, optional): Leave out features. Example: true
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_customer_buyer` (`string`, optional): Buyer reference. Example: cust-42
- `reference_segment` (`string`, optional): Segment. Example: demo-eur
- `size_page` (`integer`, optional): Number of records per page. Example: 20

Example input: `{}`

### `proabono_usage_get`

Get Usage · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_feature` (`string`, required): Feature reference. Example: feat-users
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725

Example input: `{"reference_customer":"<reference_customer>","reference_feature":"<reference_feature>"}`

### `proabono_usage_update_quote`

Quote Usage Update · Read-only

Preview the charge of a usage change (increment, quantity or on/off) without applying it.
Use the usage tools to apply it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_stamp` (`string`, required): 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_feature` (`string`, required): Feature reference. Example: feat-users
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true
- `html` (`boolean`, optional): HTML amounts. Example: true
- `id_subscription` (`integer`, optional): Subscription ID. Required unless reference_customer is given. Example: 10725
- `increment` (`integer`, optional): Quantity to add (negative to subtract). Example: 1
- `is_enabled` (`boolean`, optional): Enable or disable an OnOff feature. Example: true
- `next_term` (`boolean`, optional): Quote for the next term. Example: true
- `quantity_current` (`integer`, optional): New current quantity. Example: 5
- `reference_customer` (`string`, optional): Your reference for the customer. Required unless id_subscription is given. Example: cust-42

Example input: `{"date_stamp":"<date_stamp>","reference_feature":"<reference_feature>"}`

### `proabono_usages_list`

List Usages · Read-only

List feature usages, by customer, subscription or feature.
Use proabono_usage_get for one customer and feature.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_customer` (`integer`, optional): Customer ID. Example: 133700
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `reference_customer` (`string`, optional): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_feature` (`string`, optional): Feature reference. Example: feat-users

Example input: `{}`

### `proabono_balance_line_create`

Create Balance Line · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `amount` (`integer`, optional): Amount in cents, before taxes. Example: 50000
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true
- `id_customer` (`integer`, optional): Customer ID. Example: 133700
- `id_subscription` (`integer`, optional): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `label` (`string`, optional): Invoice line label. Example: Consulting (hours)
- `quantity` (`integer`, optional): Informative quantity. Example: 18

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_billing_address_update`

Update Billing Address · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `address_line1` (`string`, optional): Address line 1. Example: 123 avenue des Champs Elysees
- `address_line2` (`string`, optional): Address line 2. Example: 1st Floor
- `city` (`string`, optional): City. Example: Paris
- `company` (`string`, optional): Company name. Example: John Doe LLC
- `country` (`string`, optional): ISO country code. Example: FR
- `first_name` (`string`, optional): First name. Example: John
- `last_name` (`string`, optional): Last name. Example: Doe
- `phone` (`string`, optional): Phone. Example: +33102030405
- `region` (`string`, optional): ISO 3166-2 region code. Example: FR-75
- `tax_information` (`string`, optional): Tax/VAT number. Example: FR1234567890
- `zip_code` (`string`, optional): Postal code. Example: 75008

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_bill`

Bill Customer · Write

Invoice a customer now for their pending balance lines, optionally for a date window and with a note.
This issues a real invoice.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `date_end` (`string`, optional): Ignore after. Example: 2026-12-31T23:59:59Z
- `date_start` (`string`, optional): Ignore before. Example: 2026-12-01T00:00:00Z
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true
- `force_offline` (`boolean`, optional): Force an offline invoice. Example: true
- `note_localized` (`string`, optional): Invoice note. Example: Payment due within 30 days.

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_links_revoke`

Revoke Customer Portal Links · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_upsert`

Create or Update Customer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `email` (`string`, optional): Email. Example: john@doe.com
- `language` (`string`, optional): Language code: de, en, es, fr, nl, pt or it. One of: de, en, es, fr, nl, pt, it. Example: en. One of: `de`, `en`, `es`, `fr`, `nl`, `pt`, `it`.
- `metadata` (`object`, optional): 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"}
- `name` (`string`, optional): Full name. Example: John Doe
- `reference_affiliation` (`string`, optional): Affiliate reference. Example: janesmith
- `reference_offer` (`string`, optional): Offer the customer wants to subscribe to. Example: offer-premium
- `reference_segment` (`string`, optional): Segment reference (needed with more than one segment). Example: demo-eur

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_payment_settings_update`

Update Payment Settings · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `date_next_billing` (`string`, optional): Next billing date. Example: 2026-12-01T00:00:00Z
- `is_grey_listed` (`boolean`, optional): Block access to payment forms. Example: true
- `mode_billing` (`string`, optional): How the customer is billed (billing mode), as defined in ProAbono. Example: Automated
- `note_invoice` (`string`, optional): Note added to upcoming invoices. Example: Thank you for your business.
- `type_payment` (`string`, optional): Manual payment method. One of: ExternalBank, ExternalCash, ExternalCheck, ExternalOther. Example: ExternalBank. One of: `ExternalBank`, `ExternalCash`, `ExternalCheck`, `ExternalOther`.

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_subscription_create`

Create Subscription · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42
- `reference_offer` (`string`, required): Offer reference. Example: offer-premium
- `amount_recurrence` (`integer`, optional): Recurring amount in cents. Example: 4900
- `amount_termination` (`integer`, optional): Termination fee in cents. Example: 0
- `amount_trial` (`integer`, optional): Trial amount in cents. Example: 0
- `amount_up_front` (`integer`, optional): Up-front amount in cents. Example: 0
- `bill_now` (`boolean`, optional): Bill the start now. Example: true
- `count_min_recurrences` (`integer`, optional): Minimum committed recurrences. Example: 3
- `count_recurrences` (`integer`, optional): Number of recurrences. Example: 12
- `date_start` (`string`, optional): Start date. Example: 2026-12-01T00:00:00Z
- `description_localized` (`string`, optional): Description. Example: Custom premium plan
- `discounts` (`array`, optional): Discounts to apply, as a JSON array of objects with their references. Example: [{"ReferenceDiscount": "welcome-10"}]
- `duration_recurrence` (`integer`, optional): Recurrence length. Example: 1
- `duration_trial` (`integer`, optional): Trial duration. Example: 14
- `ensure_billable` (`boolean`, optional): Require valid payment info. Example: true
- `metadata` (`object`, optional): 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"}
- `migration` (`boolean`, optional): Migrate an existing subscription without billing. Example: true
- `reference_customer_buyer` (`string`, optional): Paying customer reference. Example: cust-42
- `title_localized` (`string`, optional): Title. Example: Premium (custom)
- `try_start` (`boolean`, optional): Try to start immediately. Example: true
- `unit_recurrence` (`string`, optional): Recurrence unit. One of: Day, Week, Month, Year. Example: Month. One of: `Day`, `Week`, `Month`, `Year`.
- `unit_trial` (`string`, optional): Trial unit. One of: Day, Week, Month, Year. Example: Day. One of: `Day`, `Week`, `Month`, `Year`.

Example input: `{"reference_customer":"<reference_customer>","reference_offer":"<reference_offer>"}`

### `proabono_subscription_start`

Start Subscription · Write

Start (or restart) a subscription, optionally billing now.
Use proabono_subscription_start_quote to preview the charge. Get subscription IDs from proabono_subscriptions_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `bill_now` (`boolean`, optional): Bill now. Example: true
- `ensure_billable` (`boolean`, optional): Require payment info. Example: true

Example input: `{"id_subscription":10725}`

### `proabono_subscription_suspend`

Suspend Subscription · Write

Suspend a subscription.
Use proabono_subscription_start to resume it. Get subscription IDs from proabono_subscriptions_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725

Example input: `{"id_subscription":10725}`

### `proabono_subscription_term_date_update`

Update Subscription Term Date · Write

Change the term (end of current period) date of a subscription.
Get subscription IDs from proabono_subscriptions_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_term` (`string`, required): New term date. Example: 2026-12-31T23:59:59Z
- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725

Example input: `{"date_term":"<date_term>","id_subscription":10725}`

### `proabono_subscription_upgrade`

Upgrade Subscription · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `reference_offer` (`string`, required): Target offer. Example: offer-premium
- `bill_now` (`boolean`, optional): Bill now. Example: true
- `ignore_engagement` (`boolean`, optional): Ignore minimum commitment. Example: true
- `immediate` (`boolean`, optional): Upgrade now (true) or at term end (false). Example: true

Example input: `{"id_subscription":10725,"reference_offer":"<reference_offer>"}`

### `proabono_usage_feature_toggle`

Enable or Disable Feature · Write

Enable or disable an OnOff feature for a customer.
Give reference_customer or id_subscription.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_stamp` (`string`, required): 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_enabled` (`boolean`, required): Enable or disable an OnOff feature. Example: true
- `reference_feature` (`string`, required): Feature reference. Example: feat-users
- `id_subscription` (`integer`, optional): Subscription ID. Required unless reference_customer is given. Example: 10725
- `reference_customer` (`string`, optional): Your reference for the customer. Required unless id_subscription is given. Example: cust-42

Example input: `{"date_stamp":"<date_stamp>","is_enabled":true,"reference_feature":"<reference_feature>"}`

### `proabono_usage_increment`

Increment Usage · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date_stamp` (`string`, required): 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
- `increment` (`integer`, required): Quantity to add (negative to subtract). Example: 1
- `reference_feature` (`string`, required): Feature reference. Example: feat-users
- `id_subscription` (`integer`, optional): Subscription ID. Required unless reference_customer is given. Example: 10725
- `reference_customer` (`string`, optional): Your reference for the customer. Required unless id_subscription is given. Example: cust-42

Example input: `{"date_stamp":"<date_stamp>","increment":1,"reference_feature":"<reference_feature>"}`

### `proabono_usage_quantity_set`

Set Usage Quantity · Write

Set the current quantity of a customer's Limitation or Consumption feature.
Use proabono_usage_increment to add a delta.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_stamp` (`string`, required): 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_current` (`integer`, required): New current quantity. Example: 5
- `reference_feature` (`string`, required): Feature reference. Example: feat-users
- `id_subscription` (`integer`, optional): Subscription ID. Required unless reference_customer is given. Example: 10725
- `reference_customer` (`string`, optional): Your reference for the customer. Required unless id_subscription is given. Example: cust-42

Example input: `{"date_stamp":"<date_stamp>","quantity_current":5,"reference_feature":"<reference_feature>"}`

### `proabono_usages_bulk_update`

Update Multiple Usages · Write

Update several usages in one call (increments, quantities or on/off).
Use the single-usage tools for one change.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `usages` (`array`, required): 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"}]

Example input: `{"usages":[{"ReferenceFeature":"feat-text-messages","ReferenceCustomer":"cust-42","Increment":57,"DateStamp":"2026-11-17T10:00:00Z"}]}`

### `proabono_customer_anonymize`

Anonymize Customer · Destructive

Anonymize a customer's personal data (GDPR).
This cannot be undone. Use the ReferenceCustomer you set when creating the customer with proabono_customer_upsert.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_invalidate`

Invalidate Customer · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_customer_suspend`

Suspend Customer · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `reference_customer` (`string`, required): Your own unique reference for the customer (the ReferenceCustomer you set when creating it). Example: cust-42

Example input: `{"reference_customer":"<reference_customer>"}`

### `proabono_subscription_terminate`

Terminate Subscription · Destructive

Terminate a subscription at renewal, immediately or on a chosen date.
Get subscription IDs from proabono_subscriptions_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id_subscription` (`integer`, required): ProAbono subscription ID (integer). Get it from proabono_subscriptions_list or proabono_subscription_get_by_customer. Example: 10725
- `date_termination` (`string`, optional): Termination date. Example: 2026-12-31T23:59:59Z
- `immediate` (`boolean`, optional): Terminate now instead of at renewal. Example: true

Example input: `{"id_subscription":10725}`

## Related

Other Accounting & Finance connectors ([all 82](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
