# Chargebee Integration via LowCodeAPI

**Last Updated**: February 11, 2026

## Overview
Subscription billing and recurring revenue management platform

**Categories:**
- {'id': 'payment-processing', 'name': 'Payment Processing'}

## Base Endpoint
https://api.lowcodeapi.com/chargebee

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** TOKEN

**Official Documentation:** https://apidocs.chargebee.com

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Create Customer

**Method:** POST
**LowCodeAPI Path:** /v2/customers

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/customers

### List Customers

**Method:** GET
**LowCodeAPI Path:** /v2/customers

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/chargebee/v2/customers?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/customers

### Retrieve Customer

**Method:** GET
**LowCodeAPI Path:** /v2/customers/{id}

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/customers

### Update Customer

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/customers

### Delete Customer

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}/delete

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/delete?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/delete?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}/delete?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/delete

### Move Customer

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}/move

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/move?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/move?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}/move?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/move

### Change Customer Billing Date

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}/change_billing_date

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/change_billing_date?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/change_billing_date?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}/change_billing_date?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/change_billing_date

### Merge Customer

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}/merge

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/merge?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/merge?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}/merge?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/merge

### Clear Customer Personal Data

**Method:** POST
**LowCodeAPI Path:** /v2/customers/{id}/clear_personal_data

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/clear_personal_data?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/customers/{id}/clear_personal_data?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/customers/{id}/clear_personal_data?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/clear_personal_data

### Create Subscription

**Method:** POST
**LowCodeAPI Path:** /v2/subscriptions

**New Format URL:**
https://api.lowcodeapi.com/chargebee/v2/subscriptions?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/chargebee/v2/subscriptions?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/chargebee/v2/subscriptions?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://apidocs.chargebee.com/docs/api/subscriptions


## Usage Examples

### Example 1: Create a Payment Intent

```bash
# Create a new payment intent
curl -X POST "https://api.lowcodeapi.com/chargebee/v1/payments?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "currency": "usd",
    "payment_method": "pm_card_visa"
  }'

# Response includes payment ID: pay_abc123
```

### Example 2: Retrieve Payment Details

```bash
# Get payment details using ID from previous response
curl -X GET "https://api.lowcodeapi.com/chargebee/v1/payments/{PAYMENT_ID}?api_token=YOUR_API_TOKEN"
```

### Example 3: List All Payments

```bash
# List all payments with pagination
curl -X GET "https://api.lowcodeapi.com/chargebee/v1/payments?api_token=YOUR_API_TOKEN&limit=10"
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Create Customer | POST | Customers |
| List Customers | GET | Customers |
| Retrieve Customer | GET | Customers |
| Update Customer | POST | Customers |
| Delete Customer | POST | Customers |
| Move Customer | POST | Customers |
| Change Customer Billing Date | POST | Customers |
| Merge Customer | POST | Customers |
| Clear Customer Personal Data | POST | Customers |
| Create Subscription | POST | Subscriptions |
| List Subscriptions | GET | Subscriptions |
| Retrieve Subscription | GET | Subscriptions |
| Update Subscription | POST | Subscriptions |
| Cancel Subscription | POST | Subscriptions |
| Reactivate Subscription | POST | Subscriptions |
| Pause Subscription | POST | Subscriptions |
| Resume Subscription | POST | Subscriptions |
| Delete Subscription | POST | Subscriptions |
| Change Subscription Term End | POST | Subscriptions |
| Cancel Subscription Items | POST | Subscriptions |
| Update Subscription Items | POST | Subscriptions |
| Change Term End For Items | POST | Subscriptions |
| Import Subscription | POST | Subscriptions |
| Import Subscription For Items | POST | Subscriptions |
| Override Subscription Billing Profile | POST | Subscriptions |
| Delete Override Billing Profile | POST | Subscriptions |
| Create Invoice | POST | Invoices |
| List Invoices | GET | Invoices |
| Retrieve Invoice | GET | Invoices |
| Update Invoice | POST | Invoices |
| Record Invoice Payment | POST | Invoices |
| Record Invoice Refund | POST | Invoices |
| Void Invoice | POST | Invoices |
| Write Off Invoice | POST | Invoices |
| Delete Invoice | POST | Invoices |
| Collect Invoice Payment | POST | Invoices |
| Add Charge To Invoice | POST | Invoices |
| Add Addon Charge To Invoice | POST | Invoices |
| Close Invoice | POST | Invoices |
| Reopen Invoice | POST | Invoices |
| Import Invoice | POST | Invoices |
| Apply Credits To Invoice | POST | Invoices |
| Remove Credit From Invoice | POST | Invoices |
| Refund Invoice | POST | Invoices |
| Record Tax Withheld Refund | POST | Invoices |
| Remove Tax Withheld Refund | POST | Invoices |
| Send Invoice | POST | Invoices |
| Remind Invoice | POST | Invoices |
| Write Off And Invoice | POST | Invoices |
| Create Credit Note | POST | Credit Notes |
| List Credit Notes | GET | Credit Notes |
| Retrieve Credit Note | GET | Credit Notes |
| Update Credit Note | POST | Credit Notes |
| Record Credit Note Refund | POST | Credit Notes |
| Void Credit Note | POST | Credit Notes |
| Delete Credit Note | POST | Credit Notes |
| Import Credit Note | POST | Credit Notes |
| Send Credit Note | POST | Credit Notes |
| List Transactions | GET | Transactions |
| Retrieve Transaction | GET | Transactions |
| Refund Transaction | POST | Transactions |
| Create Item | POST | Items |
| List Items | GET | Items |
| Retrieve Item | GET | Items |
| Update Item | POST | Items |
| Delete Item | POST | Items |
| Create Item Price | POST | Item Prices |
| List Item Prices | GET | Item Prices |
| Retrieve Item Price | GET | Item Prices |
| Update Item Price | POST | Item Prices |
| Delete Item Price | POST | Item Prices |
| Create Attached Item | POST | Attached Items |
| List Attached Items | GET | Attached Items |
| Retrieve Attached Item | GET | Attached Items |
| Update Attached Item | POST | Attached Items |
| Delete Attached Item | POST | Attached Items |
| Create Coupon | POST | Coupons |
| List Coupons | GET | Coupons |
| Retrieve Coupon | GET | Coupons |
| Update Coupon | POST | Coupons |
| Delete Coupon | POST | Coupons |
| Unarchive Coupon | POST | Coupons |
| Copy Coupon | POST | Coupons |
| Create Coupon Set | POST | Coupon Sets |
| List Coupon Sets | GET | Coupon Sets |
| Retrieve Coupon Set | GET | Coupon Sets |
| Update Coupon Set | POST | Coupon Sets |
| Delete Coupon Set | POST | Coupon Sets |
| Create Plan | POST | Plans |
| List Plans | GET | Plans |
| Retrieve Plan | GET | Plans |
| Update Plan | POST | Plans |
| Delete Plan | POST | Plans |
| Create Addon | POST | Addons |
| List Addons | GET | Addons |
| Retrieve Addon | GET | Addons |
| Update Addon | POST | Addons |
| Delete Addon | POST | Addons |
| List Events | GET | Events |
| Retrieve Event | GET | Events |
| Create Hosted Page | POST | Hosted Pages |
| List Hosted Pages | GET | Hosted Pages |
| Retrieve Hosted Page | GET | Hosted Pages |
| Checkout New Subscription | POST | Hosted Pages |
| Checkout Existing Subscription | POST | Hosted Pages |
| Update Payment Method | POST | Hosted Pages |
| Collect Payment Now | POST | Hosted Pages |
| Manage Payment Sources | POST | Hosted Pages |
| Extend Subscription | POST | Hosted Pages |
| Checkout Gift Subscription | POST | Hosted Pages |
| Claim Gift Subscription | POST | Hosted Pages |
| Checkout One Time Charge | POST | Hosted Pages |
| Create Virtual Bank Account | POST | Virtual Bank Accounts |
| List Virtual Bank Accounts | GET | Virtual Bank Accounts |
| Retrieve Virtual Bank Account | GET | Virtual Bank Accounts |
| Update Virtual Bank Account | POST | Virtual Bank Accounts |
| Create Payment Source | POST | Payment Sources |
| List Payment Sources | GET | Payment Sources |
| Retrieve Payment Source | GET | Payment Sources |
| Update Payment Source | POST | Payment Sources |
| Verify Payment Source | POST | Payment Sources |
| Delete Payment Source | POST | Payment Sources |
| Create Usage | POST | Usages |
| List Usages | GET | Usages |
| Retrieve Usage | GET | Usages |
| Update Usage | POST | Usages |
| Delete Usage | POST | Usages |
| Get Hierarchy | GET | Hierarchies |
| Update Hierarchy Access | POST | Hierarchies |
| Link Customer To Hierarchy | POST | Hierarchies |
| Delink Customer From Hierarchy | POST | Hierarchies |
| List Currencies | GET | Currencies |
| Retrieve Currency | GET | Currencies |
| List Webhooks | GET | Webhooks |
| Create Export | POST | Exports |
| List Exports | GET | Exports |
| Retrieve Export | GET | Exports |
| Create Import | POST | Imports |
| List Imports | GET | Imports |
| Retrieve Import | GET | Imports |
| Retrieve Latest Resource Migration | GET | Resource Migrations |
| Transfer Resource To Business Entity | POST | Business Entity Transfers |
| List Business Entity Transfers | GET | Business Entity Transfers |
| Retrieve Business Entity Transfer | GET | Business Entity Transfers |
| Create Time Machine | POST | Time Machines |
| List Time Machines | GET | Time Machines |
| Retrieve Time Machine | GET | Time Machines |
| Create Third Party Payment Method | POST | Third Party Payment Methods |
| List Third Party Payment Methods | GET | Third Party Payment Methods |
| Retrieve Third Party Payment Method | GET | Third Party Payment Methods |
| Update Third Party Payment Method | POST | Third Party Payment Methods |
| Create Unbilled Charge | POST | Unbilled Charges |
| List Unbilled Charges | GET | Unbilled Charges |
| Retrieve Unbilled Charge | GET | Unbilled Charges |
| Update Unbilled Charge | POST | Unbilled Charges |
| Delete Unbilled Charge | POST | Unbilled Charges |
| Invoice Unbilled Charges | POST | Unbilled Charges |
| Create Payment Intent | POST | Payment Intents |
| List Payment Intents | GET | Payment Intents |
| Retrieve Payment Intent | GET | Payment Intents |
| Update Payment Intent | POST | Payment Intents |
| Create Quoted Subscription | POST | Quoted Subscriptions |
| Retrieve Quoted Subscription | GET | Quoted Subscriptions |
| Convert Quoted Subscription | POST | Quoted Subscriptions |
| Create Quote | POST | Quotes |
| List Quotes | GET | Quotes |
| Retrieve Quote | GET | Quotes |
| Update Quote | POST | Quotes |
| Convert Quote | POST | Quotes |
| Delete Quote | POST | Quotes |
| Download Quote PDF | POST | Quotes |
| Create Order | POST | Orders |
| List Orders | GET | Orders |
| Retrieve Order | GET | Orders |
| Update Order | POST | Orders |
| Cancel Order | POST | Orders |
| Reopen Order | POST | Orders |
| Create Gift | POST | Gifts |
| List Gifts | GET | Gifts |
| Retrieve Gift | GET | Gifts |
| Claim Gift | POST | Gifts |
| Cancel Gift | POST | Gifts |
| Update Gift | POST | Gifts |
| List Payment Allocations | GET | Payment Allocations |
| Retrieve Payment Allocation | GET | Payment Allocations |
| Create Estimate | POST | Estimates |
| Retrieve Estimate | GET | Estimates |
| Create Address | POST | Addresses |
| List Addresses | GET | Addresses |
| Retrieve Address | GET | Addresses |
| Update Address | POST | Addresses |
| Delete Address | POST | Addresses |
| Create Contact | POST | Contacts |
| List Contacts | GET | Contacts |
| Retrieve Contact | GET | Contacts |
| Update Contact | POST | Contacts |
| Delete Contact | POST | Contacts |
| Create Tax Profile | POST | Tax Profiles |
| List Tax Profiles | GET | Tax Profiles |
| Retrieve Tax Profile | GET | Tax Profiles |
| Update Tax Profile | POST | Tax Profiles |
| Delete Tax Profile | POST | Tax Profiles |
| Create Tax Withholding | POST | Tax Withholdings |
| List Tax Withholdings | GET | Tax Withholdings |
| Retrieve Tax Withholding | GET | Tax Withholdings |
| Update Tax Withholding | POST | Tax Withholdings |
| Delete Tax Withholding | POST | Tax Withholdings |
| Add Promotional Credits | POST | Promotional Credits |
| List Promotional Credits | GET | Promotional Credits |
| Retrieve Promotional Credit | GET | Promotional Credits |
| Deduct Promotional Credits | POST | Promotional Credits |
| Set Promotional Credits | POST | Promotional Credits |
| Create Payment Reference Number | POST | Payment Reference Numbers |
| List Payment Reference Numbers | GET | Payment Reference Numbers |
| Retrieve Payment Reference Number | GET | Payment Reference Numbers |
| Update Payment Reference Number | POST | Payment Reference Numbers |
| Delete Payment Reference Number | POST | Payment Reference Numbers |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/chargebee/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/chargebee/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```