Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Chargebee

Scalekit connector
Open markdown

The Chargebee connector lets your AI agent act in each user's Chargebee account. Each user connects their own Chargebee API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 27 tools.

Tools
27
What they doRead · write · destructive
15 · 10 · 215 read10 write2 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Chargebee connection

    In AgentKit > Connections, create a Chargebee connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • chargebee_coupon_getGet one Chargebee coupon by ID.Read-only

    Get Coupon

    Get one Chargebee coupon by ID. Returns the coupon with discount, duration, validity dates, redemption limits and the item constraints it applies to. Use chargebee_coupon_get when you have the coupon ID. Use chargebee_coupons_list to browse coupons.

    Inputs

    coupon_idstringrequired
    ID of the coupon, from chargebee_coupons_list. Example: SUMMER20.
  • chargebee_coupons_listList coupons in Chargebee, optionally filtered by status, discount type, duration type, name or creation time.Read-only

    List Coupons

    List coupons in Chargebee, optionally filtered by status, discount type, duration type, name or creation time. Returns a list of coupon objects (id, name, discount_type, discount_percentage or discount_amount, duration_type, status, redemptions) and next_offset when more pages exist. Use chargebee_coupons_list to find a coupon to apply. Use chargebee_coupon_get when you already have the coupon ID.

    Inputs

    created_afterinteger
    Only coupons created after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
    discount_typestring
    Only coupons with this discount type. Example: percentage.one of fixed_amountpercentageoffer_quantity
    duration_typestring
    Only coupons with this duration type. Example: forever.one of one_timeforeverlimited_period
    limitinteger
    Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
    name_starts_withstring
    Only coupons whose name starts with this text. Example: Summer.
    offsetstring
    Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
    sort_by_descstring
    Sort the results in descending order by this attribute. Example: created_at.one of created_at
    statusstring
    Only coupons in this status. Example: active.one of activeexpiredarchiveddeletedfuture
  • chargebee_credit_note_getGet one Chargebee credit note by ID.Read-only

    Get Credit Note

    Get one Chargebee credit note by ID. Returns the credit note with line items, taxes, allocations to invoices and refunds. Use chargebee_credit_note_get when you have the credit note ID. Use chargebee_credit_notes_list to search.

    Inputs

    credit_note_idstringrequired
    ID of the credit note, from chargebee_credit_notes_list. Example: CN-112.
  • chargebee_credit_notes_listList credit notes in Chargebee, optionally filtered by customer, subscription, reference invoice, status, type or date.Read-only

    List Credit Notes

    List credit notes in Chargebee, optionally filtered by customer, subscription, reference invoice, status, type or date. Returns a list of credit note objects (id, type, status, reference_invoice_id, total, amount_allocated, amount_refunded, amount_available) and next_offset when more pages exist. Use chargebee_credit_notes_list to find credits or refunds. Use chargebee_credit_note_get when you already have the credit note ID.

    Inputs

    customer_idstring
    Only credit notes of this customer ID. Example: 16BjfNSzYXqA21Dt.
    date_afterinteger
    Only credit notes dated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
    date_beforeinteger
    Only credit notes dated before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
    include_deletedboolean
    Set to true to also return deleted credit notes. Defaults to false.
    limitinteger
    Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
    offsetstring
    Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
    reference_invoice_idstring
    Only credit notes issued against this invoice ID. Example: 1024.
    sort_by_ascstring
    Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of date
    sort_by_descstring
    Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: date.one of date
    statusstring
    Only credit notes in this status. Example: refund_due.one of adjustedrefundedrefund_duevoided
    subscription_idstring
    Only credit notes of this subscription ID. Example: AzZTZgTSz7nCt3Pu.
    typestring
    Only credit notes of this type. Example: refundable.one of adjustmentrefundablestore
  • chargebee_customer_getGet one Chargebee customer by ID.Read-only

    Get Customer

    Get one Chargebee customer by ID. Returns the customer object (contact details, billing address, payment method summary, balances, meta_data) and its primary card if any. Use chargebee_customer_get when you have the customer ID. Use chargebee_customers_list to search by email or name.

    Inputs

    customer_idstringrequired
    ID of the customer, from chargebee_customers_list or the Chargebee app. Example: 16BjfNSzYXqA21Dt.
  • chargebee_customers_listList customers in Chargebee, optionally filtered by email, name, company or created/updated time.Read-only

    List Customers

    List customers in Chargebee, optionally filtered by email, name, company or created/updated time. Returns a list of customer objects (id, name, email, company, billing address, auto_collection, balances) and next_offset when more pages exist. Use chargebee_customers_list to find a customer or browse. Use chargebee_customer_get when you already have the customer ID.

    Inputs

    companystring
    Only customers with exactly this company name. Example: Acme Inc.
    created_afterinteger
    Only customers created after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
    created_beforeinteger
    Only customers created before this time. Unix timestamp in seconds (UTC). Example: 1735689600.
    emailstring
    Only customers with exactly this email address. Example: jane@acme.com.
    first_namestring
    Only customers with exactly this first name. Example: Jane.
    include_deletedboolean
    Set to true to also return deleted customers. Defaults to false.
    last_namestring
    Only customers with exactly this last name. Example: Doe.
    limitinteger
    Number of records to return per page, from 1 to 100. Chargebee returns 10 when not set. Example: 25.
    offsetstring
    Pagination cursor. Pass the next_offset value from the previous page's response to get the next page. Leave empty for the first page. Example: ["1735689600000","230000000123"].
    sort_by_ascstring
    Sort the results in ascending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of created_atupdated_at
    sort_by_descstring
    Sort the results in descending order by this attribute. Use either sort_by_asc or sort_by_desc, not both. Example: created_at.one of created_atupdated_at
    updated_afterinteger
    Only customers updated after this time. Unix timestamp in seconds (UTC). Example: 1735689600.
  • chargebee_invoice_getGet one Chargebee invoice by ID.Read-only

    Get Invoice

    Get one Chargebee invoice by ID. Returns the invoice with line items, discounts, taxes, applied payments and credits, and amounts paid and due. Use chargebee_invoice_get when you have the invoice ID. Use chargebee_invoices_list to search, and chargebee_invoice_pdf_get for a PDF link.

    Inputs

    invoice_idstringrequired
    ID (number) of the invoice, from chargebee_invoices_list. Example: 1024.
  • chargebee_invoice_pdf_getGet a temporary download link for an invoice's PDF.Read-only

    Get Invoice PDF Link

    Get a temporary download link for an invoice's PDF. Returns a download object with download_url and valid_till (the link expires after about an hour). Use chargebee_invoice_pdf_get to share or save an invoice document. Use chargebee_invoice_get for the invoice data.

    Inputs

    invoice_idstringrequired
    ID (number) of the invoice, from chargebee_invoices_list. Example: 1024.
    disposition_typestring
    attachment (default) makes the link download the file; inline opens it in the browser. Example: inline.one of attachmentinline