---
canonical_url: "https://docs.composio.dev/toolkits/billsby"
markdown_url: "https://docs.composio.dev/toolkits/billsby.md"
product: "platform"
version: null
last_updated: null
---

# Billsby

Billsby is a subscription billing platform for managing customers, subscriptions, invoices, products, plans, usage counters, add-ons, and allowances.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `BILLSBY`
- **Version:** 00000000_00

## Tools

### Create Customer

**Slug:** `BILLSBY_CREATE_CUSTOMER`

Create a Billsby customer without a subscription or payment card. This does not start recurring billing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Customer email address. |
| `last_name` | string | Yes | Customer last name. |
| `first_name` | string | Yes | Customer first name. |
| `billing_address` | object | Yes | Billing address for the new customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `BILLSBY_GET_CUSTOMER`

Get billing, contact, payment-status, and account details for one Billsby customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_unique_id` | string | Yes | Billsby customer unique ID, usually obtained from List Customers or Create Customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription

**Slug:** `BILLSBY_GET_SUBSCRIPTION`

Get billing schedule, customer, product, plan, pricing, status, and revenue details for one Billsby subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_unique_id` | string | Yes | Billsby subscription unique ID, usually obtained from List Subscriptions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription Shipping Address

**Slug:** `BILLSBY_GET_SUBSCRIPTION_SHIPPING_ADDRESS`

Get the shipping address associated with one Billsby subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_unique_id` | string | Yes | Billsby subscription unique ID whose shipping address should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `BILLSBY_LIST_CUSTOMERS`

Return one page of customers for the connected Billsby company, optionally filtered by a partial customer name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Partial customer name to match. Omit to list all customers. |
| `page_size` | integer | No | Number of customers to request for this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page; the cursor retains the original search and page size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Subscriptions

**Slug:** `BILLSBY_LIST_CUSTOMER_SUBSCRIPTIONS`

List all subscriptions belonging to one Billsby customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_unique_id` | string | Yes | Billsby customer unique ID whose subscriptions should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Plans

**Slug:** `BILLSBY_LIST_PRODUCT_PLANS`

List the plans and billing cycles configured for one Billsby product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | Billsby product ID, usually obtained from List Products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `BILLSBY_LIST_PRODUCTS`

Return one page of Billsby products, optionally filtered by name or visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Partial product name to match. Omit to list all products. |
| `page_size` | integer | No | Number of products to request for this page (1-100). |
| `visibility` | integer | No | Billsby visibility code: 0 public, 1 hidden, 2 internal, or 3 off-sale. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page; the cursor retains the original filters and page size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscriptions

**Slug:** `BILLSBY_LIST_SUBSCRIPTIONS`

Return one page of company subscriptions with optional status, trial, product, plan, and ordering filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string | No | Subscription object property to order by. Billsby accepts any property using its provider casing, such as CreatedOn. |
| `is_active` | boolean | No | When set, filter by active status. |
| `page_size` | integer | No | Number of subscriptions to request for this page (1-100). |
| `plan_name` | string | No | Filter subscriptions by matching plan name. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page; the cursor retains the original filters, ordering, and page size. |
| `product_name` | string | No | Filter subscriptions by matching product name. |
| `is_in_free_trial` | boolean | No | When set, filter by free-trial status. |
| `order_descending` | boolean | No | Whether to sort the order_by property descending. Omit when order_by is omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `BILLSBY_UPDATE_CUSTOMER`

Replace the editable contact and billing-address details for an existing Billsby customer. Supply the complete desired values, not a partial patch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Complete desired email address. |
| `last_name` | string | Yes | Complete desired last name. |
| `first_name` | string | Yes | Complete desired first name. |
| `phone_number` | string | No | Phone number without a leading zero, per Billsby documentation. |
| `billing_address` | object | Yes | Complete desired billing address. |
| `customer_unique_id` | string | Yes | Billsby customer unique ID to update. |
| `phone_number_dial_code` | string | No | International phone dial code, such as +1. |
| `phone_number_dial_country` | string | No | Phone dial country, if the customer has a phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |