KosmoKrator

productivity

Chargebee Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Chargebee KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.chargebee.*. Use lua_read_doc("integrations.chargebee") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Chargebee workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.chargebee.cancel_subscription_items({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("chargebee"))' --json
kosmo integrations:lua --eval 'print(docs.read("chargebee.cancel_subscription_items"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local chargebee = app.integrations.chargebee
local result = chargebee.cancel_subscription_items({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.chargebee, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.chargebee.default.* or app.integrations.chargebee.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Chargebee, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Chargebee Lua API Reference

Namespace: app.integrations.chargebee

Use this integration to inspect and manage Chargebee API v2 billing records. Configure a Chargebee API key and site name before use.

Return Shape

Tools return the decoded Chargebee JSON response. List endpoints usually return a list array and may include next_offset. Retrieve and write endpoints return resource objects such as customer, subscription, invoice, transaction, hosted_page, estimate, or event.

Common Parameters

Read tools commonly accept:

NameTypeRequiredDescription
limitintegernoMaximum records to return.
offsetstringnoPagination offset from next_offset.
id[is]stringnoExact ID filter where supported.
status[is]stringnoExact status filter where supported.
customer_id[is]stringnoExact customer filter where supported.
subscription_id[is]stringnoExact subscription filter where supported.
updated_at[after]integernoUnix timestamp filter.
created_at[after]integernoUnix timestamp filter.

Resource Coverage

The namespace includes list/get/create/update/delete style tools for customers, items, item prices and coupons, plus read tools for subscriptions, invoices, credit notes, transactions, events, hosted pages, orders, business entities and attached items.

Important workflow tools include:

ToolPurpose
create_subscription_for_itemsCreate an item-price subscription.
create_subscription_for_customerCreate a subscription under an existing customer.
update_subscription_for_itemsUpdate a Product Catalog 2.0 subscription.
cancel_subscription_for_itemsCancel a subscription.
close_invoiceFinalize a pending invoice.
collect_invoice_paymentCollect payment for an invoice.
record_invoice_paymentRecord an offline invoice payment.
create_invoice_for_charge_items_and_chargesCreate a non-recurring invoice.
record_refund_for_transactionRecord an offline refund.
checkout_new_for_itemsCreate a hosted checkout page for a new subscription.
checkout_existing_for_itemsCreate a hosted checkout page for an existing subscription.
estimate_create_subscription_for_itemsPreview a subscription create operation.
estimate_update_subscription_for_itemsPreview a subscription update operation.

Payload Tools

Chargebee write endpoints use form-encoded parameter names. Pass those exact names inside payload, including bracketed array keys from the API docs.

local result = app.integrations.chargebee.create_subscription_for_customer({
  customer_id = "customer_123",
  payload = {
    ["subscription_items[item_price_id][0]"] = "basic-USD",
    ["subscription_items[quantity][0]"] = 3,
    invoice_immediately = true
  }
})
local page = app.integrations.chargebee.checkout_new_for_items({
  payload = {
    ["subscription_items[item_price_id][0]"] = "basic-USD",
    redirect_url = "https://example.test/billing/success",
    cancel_url = "https://example.test/billing/cancel"
  }
})
local payment = app.integrations.chargebee.record_invoice_payment({
  id = "inv_123",
  payload = {
    ["transaction[payment_method]"] = "bank_transfer",
    ["transaction[amount]"] = 5000,
    comment = "Wire received"
  }
})

Pagination

local first = app.integrations.chargebee.list_customers({ limit = 50 })

if first.next_offset then
  local second = app.integrations.chargebee.list_customers({
    limit = 50,
    offset = first.next_offset
  })
end

Multi-Account Usage

app.integrations.chargebee.list_subscriptions({ limit = 25 })
app.integrations.chargebee.default.list_subscriptions({ limit = 25 })
app.integrations.chargebee.production.list_subscriptions({ limit = 25 })

All account namespaces expose the same tools; only credentials differ.

Raw agent markdown 
# Chargebee Lua API Reference

Namespace: `app.integrations.chargebee`

Use this integration to inspect and manage Chargebee API v2 billing records. Configure a Chargebee API key and site name before use.

## Return Shape

Tools return the decoded Chargebee JSON response. List endpoints usually return a `list` array and may include `next_offset`. Retrieve and write endpoints return resource objects such as `customer`, `subscription`, `invoice`, `transaction`, `hosted_page`, `estimate`, or `event`.

## Common Parameters

Read tools commonly accept:

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | no | Maximum records to return. |
| `offset` | string | no | Pagination offset from `next_offset`. |
| `id[is]` | string | no | Exact ID filter where supported. |
| `status[is]` | string | no | Exact status filter where supported. |
| `customer_id[is]` | string | no | Exact customer filter where supported. |
| `subscription_id[is]` | string | no | Exact subscription filter where supported. |
| `updated_at[after]` | integer | no | Unix timestamp filter. |
| `created_at[after]` | integer | no | Unix timestamp filter. |

## Resource Coverage

The namespace includes list/get/create/update/delete style tools for customers, items, item prices and coupons, plus read tools for subscriptions, invoices, credit notes, transactions, events, hosted pages, orders, business entities and attached items.

Important workflow tools include:

| Tool | Purpose |
| --- | --- |
| `create_subscription_for_items` | Create an item-price subscription. |
| `create_subscription_for_customer` | Create a subscription under an existing customer. |
| `update_subscription_for_items` | Update a Product Catalog 2.0 subscription. |
| `cancel_subscription_for_items` | Cancel a subscription. |
| `close_invoice` | Finalize a pending invoice. |
| `collect_invoice_payment` | Collect payment for an invoice. |
| `record_invoice_payment` | Record an offline invoice payment. |
| `create_invoice_for_charge_items_and_charges` | Create a non-recurring invoice. |
| `record_refund_for_transaction` | Record an offline refund. |
| `checkout_new_for_items` | Create a hosted checkout page for a new subscription. |
| `checkout_existing_for_items` | Create a hosted checkout page for an existing subscription. |
| `estimate_create_subscription_for_items` | Preview a subscription create operation. |
| `estimate_update_subscription_for_items` | Preview a subscription update operation. |

## Payload Tools

Chargebee write endpoints use form-encoded parameter names. Pass those exact names inside `payload`, including bracketed array keys from the API docs.

```lua
local result = app.integrations.chargebee.create_subscription_for_customer({
  customer_id = "customer_123",
  payload = {
    ["subscription_items[item_price_id][0]"] = "basic-USD",
    ["subscription_items[quantity][0]"] = 3,
    invoice_immediately = true
  }
})
```

```lua
local page = app.integrations.chargebee.checkout_new_for_items({
  payload = {
    ["subscription_items[item_price_id][0]"] = "basic-USD",
    redirect_url = "https://example.test/billing/success",
    cancel_url = "https://example.test/billing/cancel"
  }
})
```

```lua
local payment = app.integrations.chargebee.record_invoice_payment({
  id = "inv_123",
  payload = {
    ["transaction[payment_method]"] = "bank_transfer",
    ["transaction[amount]"] = 5000,
    comment = "Wire received"
  }
})
```

## Pagination

```lua
local first = app.integrations.chargebee.list_customers({ limit = 50 })

if first.next_offset then
  local second = app.integrations.chargebee.list_customers({
    limit = 50,
    offset = first.next_offset
  })
end
```

## Multi-Account Usage

```lua
app.integrations.chargebee.list_subscriptions({ limit = 25 })
app.integrations.chargebee.default.list_subscriptions({ limit = 25 })
app.integrations.chargebee.production.list_subscriptions({ limit = 25 })
```

All account namespaces expose the same tools; only credentials differ.
Metadata-derived Lua example 
local result = app.integrations.chargebee.cancel_subscription_items({})
print(result)

Functions

cancel_subscription_items Write

Cancel a subscription with Product Catalog 2.0 item semantics.

Lua path
app.integrations.chargebee.cancel_subscription_items
Full name
chargebee.chargebee_cancel_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
checkout_existing_items Write

Create a hosted checkout page for an existing item-price subscription.

Lua path
app.integrations.chargebee.checkout_existing_items
Full name
chargebee.chargebee_checkout_existing_for_items
ParameterTypeRequiredDescription
No parameters.
checkout_new_items Write

Create a hosted checkout page for a new item-price subscription.

Lua path
app.integrations.chargebee.checkout_new_items
Full name
chargebee.chargebee_checkout_new_for_items
ParameterTypeRequiredDescription
No parameters.
close_invoice Write

Close a pending Chargebee invoice.

Lua path
app.integrations.chargebee.close_invoice
Full name
chargebee.chargebee_close_invoice
ParameterTypeRequiredDescription
No parameters.
collect_invoice_payment Write

Collect payment for an invoice.

Lua path
app.integrations.chargebee.collect_invoice_payment
Full name
chargebee.chargebee_collect_invoice_payment
ParameterTypeRequiredDescription
No parameters.
collect_now_hosted_page Write

Create a hosted page to collect unpaid invoices.

Lua path
app.integrations.chargebee.collect_now_hosted_page
Full name
chargebee.chargebee_collect_now_hosted_page
ParameterTypeRequiredDescription
No parameters.
create_coupon Write

Create a Chargebee coupon.

Lua path
app.integrations.chargebee.create_coupon
Full name
chargebee.chargebee_create_coupon
ParameterTypeRequiredDescription
No parameters.
create_credit_note Write

Create a credit note for an invoice.

Lua path
app.integrations.chargebee.create_credit_note
Full name
chargebee.chargebee_create_credit_note
ParameterTypeRequiredDescription
No parameters.
create_customer Write

Create a Chargebee customer.

Lua path
app.integrations.chargebee.create_customer
Full name
chargebee.chargebee_create_customer
ParameterTypeRequiredDescription
No parameters.
create_invoice_items_and Write

Create a non-recurring invoice for charge items and ad hoc charges.

Lua path
app.integrations.chargebee.create_invoice_items_and
Full name
chargebee.chargebee_create_invoice_for_charge_items_and_charges
ParameterTypeRequiredDescription
No parameters.
create_item Write

Create a Chargebee item.

Lua path
app.integrations.chargebee.create_item
Full name
chargebee.chargebee_create_item
ParameterTypeRequiredDescription
No parameters.
create_item_price Write

Create a Chargebee item price.

Lua path
app.integrations.chargebee.create_item_price
Full name
chargebee.chargebee_create_item_price
ParameterTypeRequiredDescription
No parameters.
create_payment_source Write

Create a payment source for a customer.

Lua path
app.integrations.chargebee.create_payment_source
Full name
chargebee.chargebee_create_payment_source
ParameterTypeRequiredDescription
No parameters.
create_subscription_customer Write

Create a subscription for an existing customer with item prices.

Lua path
app.integrations.chargebee.create_subscription_customer
Full name
chargebee.chargebee_create_subscription_for_customer
ParameterTypeRequiredDescription
No parameters.
create_subscription_items Write

Create a subscription with Product Catalog 2.0 item prices.

Lua path
app.integrations.chargebee.create_subscription_items
Full name
chargebee.chargebee_create_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
delete_coupon Write

Delete or archive a Chargebee coupon by ID.

Lua path
app.integrations.chargebee.delete_coupon
Full name
chargebee.chargebee_delete_coupon
ParameterTypeRequiredDescription
No parameters.
delete_credit_note Write

Delete a Chargebee credit note.

Lua path
app.integrations.chargebee.delete_credit_note
Full name
chargebee.chargebee_delete_credit_note
ParameterTypeRequiredDescription
No parameters.
delete_customer Write

Delete or archive a Chargebee customer by ID.

Lua path
app.integrations.chargebee.delete_customer
Full name
chargebee.chargebee_delete_customer
ParameterTypeRequiredDescription
No parameters.
delete_invoice Write

Delete a Chargebee invoice.

Lua path
app.integrations.chargebee.delete_invoice
Full name
chargebee.chargebee_delete_invoice
ParameterTypeRequiredDescription
No parameters.
delete_item Write

Delete or archive a Chargebee item by ID.

Lua path
app.integrations.chargebee.delete_item
Full name
chargebee.chargebee_delete_item
ParameterTypeRequiredDescription
No parameters.
delete_item_price Write

Delete or archive a Chargebee item price by ID.

Lua path
app.integrations.chargebee.delete_item_price
Full name
chargebee.chargebee_delete_item_price
ParameterTypeRequiredDescription
No parameters.
delete_payment_source Write

Delete a payment source.

Lua path
app.integrations.chargebee.delete_payment_source
Full name
chargebee.chargebee_delete_payment_source
ParameterTypeRequiredDescription
No parameters.
delete_subscription Write

Delete a Chargebee subscription.

Lua path
app.integrations.chargebee.delete_subscription
Full name
chargebee.chargebee_delete_subscription
ParameterTypeRequiredDescription
No parameters.
estimate_cancel_subscription_items Write

Estimate cancelling a subscription.

Lua path
app.integrations.chargebee.estimate_cancel_subscription_items
Full name
chargebee.chargebee_estimate_cancel_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
estimate_create_invoice_items Write

Estimate creating an invoice for item prices and charges.

Lua path
app.integrations.chargebee.estimate_create_invoice_items
Full name
chargebee.chargebee_estimate_create_invoice_for_items
ParameterTypeRequiredDescription
No parameters.
estimate_create_subscription_customer Write

Estimate creating a subscription for an existing customer.

Lua path
app.integrations.chargebee.estimate_create_subscription_customer
Full name
chargebee.chargebee_estimate_create_subscription_for_customer
ParameterTypeRequiredDescription
No parameters.
estimate_create_subscription_items Write

Estimate creating a Product Catalog 2.0 subscription.

Lua path
app.integrations.chargebee.estimate_create_subscription_items
Full name
chargebee.chargebee_estimate_create_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
estimate_renew_subscription Read

Estimate renewing a subscription.

Lua path
app.integrations.chargebee.estimate_renew_subscription
Full name
chargebee.chargebee_estimate_renew_subscription
ParameterTypeRequiredDescription
No parameters.
estimate_update_subscription_items Write

Estimate updating a Product Catalog 2.0 subscription.

Lua path
app.integrations.chargebee.estimate_update_subscription_items
Full name
chargebee.chargebee_estimate_update_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
get_attached_item Read

Retrieve a Chargebee attached item by ID.

Lua path
app.integrations.chargebee.get_attached_item
Full name
chargebee.chargebee_get_attached_item
ParameterTypeRequiredDescription
No parameters.
get_business_entity Read

Retrieve a Chargebee business entity by ID.

Lua path
app.integrations.chargebee.get_business_entity
Full name
chargebee.chargebee_get_business_entity
ParameterTypeRequiredDescription
No parameters.
get_coupon Read

Retrieve a Chargebee coupon by ID.

Lua path
app.integrations.chargebee.get_coupon
Full name
chargebee.chargebee_get_coupon
ParameterTypeRequiredDescription
No parameters.
get_credit_note Read

Retrieve a Chargebee credit note by ID.

Lua path
app.integrations.chargebee.get_credit_note
Full name
chargebee.chargebee_get_credit_note
ParameterTypeRequiredDescription
No parameters.
get_credit_note_pdf Read

Retrieve credit note PDF metadata and download URL.

Lua path
app.integrations.chargebee.get_credit_note_pdf
Full name
chargebee.chargebee_get_credit_note_pdf
ParameterTypeRequiredDescription
No parameters.
get_current_user Read

Verify Chargebee API connectivity with a lightweight subscriptions request. Use this to confirm credentials and site name are working.

Lua path
app.integrations.chargebee.get_current_user
Full name
chargebee.chargebee_get_current_user
ParameterTypeRequiredDescription
No parameters.
get_customer Read

Retrieve detailed information about a specific Chargebee customer by their ID, including contact details, billing address, and payment method.

Lua path
app.integrations.chargebee.get_customer
Full name
chargebee.chargebee_get_customer
ParameterTypeRequiredDescription
id string yes The customer ID.
get_event Read

Retrieve a Chargebee event by ID.

Lua path
app.integrations.chargebee.get_event
Full name
chargebee.chargebee_get_event
ParameterTypeRequiredDescription
No parameters.
get_hosted_page Read

Retrieve a Chargebee hosted page by ID.

Lua path
app.integrations.chargebee.get_hosted_page
Full name
chargebee.chargebee_get_hosted_page
ParameterTypeRequiredDescription
No parameters.
get_invoice Read

Retrieve detailed information about a specific Chargebee invoice by its ID, including line items, totals, tax, and payment status.

Lua path
app.integrations.chargebee.get_invoice
Full name
chargebee.chargebee_get_invoice
ParameterTypeRequiredDescription
id string yes The invoice ID.
get_invoice_pdf Read

Retrieve invoice PDF metadata and download URL.

Lua path
app.integrations.chargebee.get_invoice_pdf
Full name
chargebee.chargebee_get_invoice_pdf
ParameterTypeRequiredDescription
No parameters.
get_item Read

Retrieve a Chargebee item by ID.

Lua path
app.integrations.chargebee.get_item
Full name
chargebee.chargebee_get_item
ParameterTypeRequiredDescription
No parameters.
get_item_price Read

Retrieve a Chargebee item price by ID.

Lua path
app.integrations.chargebee.get_item_price
Full name
chargebee.chargebee_get_item_price
ParameterTypeRequiredDescription
No parameters.
get_order Read

Retrieve a Chargebee order by ID.

Lua path
app.integrations.chargebee.get_order
Full name
chargebee.chargebee_get_order
ParameterTypeRequiredDescription
No parameters.
get_payment_source Read

Retrieve a payment source by ID.

Lua path
app.integrations.chargebee.get_payment_source
Full name
chargebee.chargebee_get_payment_source
ParameterTypeRequiredDescription
No parameters.
get_subscription Read

Retrieve detailed information about a specific Chargebee subscription by its ID, including plan details, billing period, status, and associated customer.

Lua path
app.integrations.chargebee.get_subscription
Full name
chargebee.chargebee_get_subscription
ParameterTypeRequiredDescription
id string yes The subscription ID.
get_transaction Read

Retrieve a Chargebee transaction by ID.

Lua path
app.integrations.chargebee.get_transaction
Full name
chargebee.chargebee_get_transaction
ParameterTypeRequiredDescription
No parameters.
list_attached_items Read

List Chargebee attached items with filters and pagination.

Lua path
app.integrations.chargebee.list_attached_items
Full name
chargebee.chargebee_list_attached_items
ParameterTypeRequiredDescription
No parameters.
list_business_entities Read

List Chargebee business entitys with filters and pagination.

Lua path
app.integrations.chargebee.list_business_entities
Full name
chargebee.chargebee_list_business_entities
ParameterTypeRequiredDescription
No parameters.
list_coupons Read

List Chargebee coupons with filters and pagination.

Lua path
app.integrations.chargebee.list_coupons
Full name
chargebee.chargebee_list_coupons
ParameterTypeRequiredDescription
No parameters.
list_credit_notes Read

List Chargebee credit notes with filters and pagination.

Lua path
app.integrations.chargebee.list_credit_notes
Full name
chargebee.chargebee_list_credit_notes
ParameterTypeRequiredDescription
No parameters.
list_currencies Read

List Chargebee currencies.

Lua path
app.integrations.chargebee.list_currencies
Full name
chargebee.chargebee_list_currencies
ParameterTypeRequiredDescription
No parameters.
list_customers Read

List customers from Chargebee with pagination. Returns customer details including email, name, company, and billing address.

Lua path
app.integrations.chargebee.list_customers
Full name
chargebee.chargebee_list_customers
ParameterTypeRequiredDescription
limit integer no Number of customers to return per page (max 100, default 10).
page string no Pagination cursor. Pass the value from a previous response to get the next page.
list_events Read

List Chargebee events with filters and pagination.

Lua path
app.integrations.chargebee.list_events
Full name
chargebee.chargebee_list_events
ParameterTypeRequiredDescription
No parameters.
list_hosted_pages Read

List Chargebee hosted pages with filters and pagination.

Lua path
app.integrations.chargebee.list_hosted_pages
Full name
chargebee.chargebee_list_hosted_pages
ParameterTypeRequiredDescription
No parameters.
list_invoice_payment_schedules Read

Retrieve payment schedules for an invoice.

Lua path
app.integrations.chargebee.list_invoice_payment_schedules
Full name
chargebee.chargebee_list_invoice_payment_schedules
ParameterTypeRequiredDescription
No parameters.
list_invoices Read

List invoices from Chargebee. Supports filtering by status (paid, posted, payment_due, not_paid, voided, pending) and pagination.

Lua path
app.integrations.chargebee.list_invoices
Full name
chargebee.chargebee_list_invoices
ParameterTypeRequiredDescription
limit integer no Number of invoices to return per page (max 100, default 10).
page string no Pagination cursor. Pass the value from a previous response to get the next page.
status string no Filter by invoice status: paid, posted, payment_due, not_paid, voided, pending.
list_item_prices Read

List Chargebee item prices with filters and pagination.

Lua path
app.integrations.chargebee.list_item_prices
Full name
chargebee.chargebee_list_item_prices
ParameterTypeRequiredDescription
No parameters.
list_items Read

List Chargebee items with filters and pagination.

Lua path
app.integrations.chargebee.list_items
Full name
chargebee.chargebee_list_items
ParameterTypeRequiredDescription
No parameters.
list_orders Read

List Chargebee orders with filters and pagination.

Lua path
app.integrations.chargebee.list_orders
Full name
chargebee.chargebee_list_orders
ParameterTypeRequiredDescription
No parameters.
list_payment_sources_customer Read

List payment sources for a customer.

Lua path
app.integrations.chargebee.list_payment_sources_customer
Full name
chargebee.chargebee_list_payment_sources_for_customer
ParameterTypeRequiredDescription
No parameters.
list_subscriptions Read

List subscriptions from Chargebee. Supports filtering by state (active, cancelled, non_renewing, paused, in_trial, future) and pagination. Returns subscription details including plan, status, and billing period.

Lua path
app.integrations.chargebee.list_subscriptions
Full name
chargebee.chargebee_list_subscriptions
ParameterTypeRequiredDescription
limit integer no Number of subscriptions to return per page (max 100, default 10).
page string no Pagination cursor. Pass the value from a previous response to get the next page.
state string no Filter by subscription state: active, cancelled, non_renewing, paused, in_trial, future.
list_transactions Read

List Chargebee transactions with filters and pagination.

Lua path
app.integrations.chargebee.list_transactions
Full name
chargebee.chargebee_list_transactions
ParameterTypeRequiredDescription
No parameters.
manage_payment_sources_hosted_page Write

Create a hosted page for managing payment sources.

Lua path
app.integrations.chargebee.manage_payment_sources_hosted_page
Full name
chargebee.chargebee_manage_payment_sources_hosted_page
ParameterTypeRequiredDescription
No parameters.
pause_subscription Write

Pause a Chargebee subscription.

Lua path
app.integrations.chargebee.pause_subscription
Full name
chargebee.chargebee_pause_subscription
ParameterTypeRequiredDescription
No parameters.
reactivate_subscription Write

Reactivate a cancelled Chargebee subscription.

Lua path
app.integrations.chargebee.reactivate_subscription
Full name
chargebee.chargebee_reactivate_subscription
ParameterTypeRequiredDescription
No parameters.
record_invoice_payment Write

Record an offline payment for an invoice.

Lua path
app.integrations.chargebee.record_invoice_payment
Full name
chargebee.chargebee_record_invoice_payment
ParameterTypeRequiredDescription
No parameters.
record_refund_transaction Write

Record an offline refund for a transaction.

Lua path
app.integrations.chargebee.record_refund_transaction
Full name
chargebee.chargebee_record_refund_for_transaction
ParameterTypeRequiredDescription
No parameters.
remove_scheduled_cancellation Write

Remove a scheduled subscription cancellation.

Lua path
app.integrations.chargebee.remove_scheduled_cancellation
Full name
chargebee.chargebee_remove_scheduled_cancellation
ParameterTypeRequiredDescription
No parameters.
remove_scheduled_changes Write

Remove scheduled changes from a subscription.

Lua path
app.integrations.chargebee.remove_scheduled_changes
Full name
chargebee.chargebee_remove_scheduled_changes
ParameterTypeRequiredDescription
No parameters.
resume_subscription Write

Resume a paused Chargebee subscription.

Lua path
app.integrations.chargebee.resume_subscription
Full name
chargebee.chargebee_resume_subscription
ParameterTypeRequiredDescription
No parameters.
retrieve_subscription_with_scheduled_changes Read

Retrieve a subscription including scheduled changes.

Lua path
app.integrations.chargebee.retrieve_subscription_with_scheduled_changes
Full name
chargebee.chargebee_retrieve_subscription_with_scheduled_changes
ParameterTypeRequiredDescription
No parameters.
update_coupon Write

Update a Chargebee coupon by ID.

Lua path
app.integrations.chargebee.update_coupon
Full name
chargebee.chargebee_update_coupon
ParameterTypeRequiredDescription
No parameters.
update_customer Write

Update a Chargebee customer by ID.

Lua path
app.integrations.chargebee.update_customer
Full name
chargebee.chargebee_update_customer
ParameterTypeRequiredDescription
No parameters.
update_item Write

Update a Chargebee item by ID.

Lua path
app.integrations.chargebee.update_item
Full name
chargebee.chargebee_update_item
ParameterTypeRequiredDescription
No parameters.
update_item_price Write

Update a Chargebee item price by ID.

Lua path
app.integrations.chargebee.update_item_price
Full name
chargebee.chargebee_update_item_price
ParameterTypeRequiredDescription
No parameters.
update_payment_method_hosted_page Write

Create a hosted page for updating payment method.

Lua path
app.integrations.chargebee.update_payment_method_hosted_page
Full name
chargebee.chargebee_update_payment_method_hosted_page
ParameterTypeRequiredDescription
No parameters.
update_subscription_items Write

Update a subscription with Product Catalog 2.0 item prices.

Lua path
app.integrations.chargebee.update_subscription_items
Full name
chargebee.chargebee_update_subscription_for_items
ParameterTypeRequiredDescription
No parameters.
void_credit_note Write

Void a Chargebee credit note.

Lua path
app.integrations.chargebee.void_credit_note
Full name
chargebee.chargebee_void_credit_note
ParameterTypeRequiredDescription
No parameters.
void_invoice Write

Void a Chargebee invoice.

Lua path
app.integrations.chargebee.void_invoice
Full name
chargebee.chargebee_void_invoice
ParameterTypeRequiredDescription
No parameters.
void_transaction Write

Void a Chargebee transaction.

Lua path
app.integrations.chargebee.void_transaction
Full name
chargebee.chargebee_void_transaction
ParameterTypeRequiredDescription
No parameters.