> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Billsby

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

![Billsby logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/billsby.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=a846371063bd3221875e76104f4c225e)

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

## Tools

> [accordion] Create Customer
>
> **Slug:** `BILLSBY_CREATE_CUSTOMER`
>
> Create a Billsby customer without a subscription or payment card. This does not start recurring billing.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Customer email address.
>
> **last\_name** `string` *required*
>
> Customer last name.
>
> **first\_name** `string` *required*
>
> Customer first name.
>
> **billing\_address** `object` *required*
>
> Billing address for the new customer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer
>
> **Slug:** `BILLSBY_GET_CUSTOMER`
>
> Get billing, contact, payment-status, and account details for one Billsby customer.
>
> #### Input Parameters
>
> **customer\_unique\_id** `string` *required*
>
> Billsby customer unique ID, usually obtained from List Customers or Create Customer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subscription
>
> **Slug:** `BILLSBY_GET_SUBSCRIPTION`
>
> Get billing schedule, customer, product, plan, pricing, status, and revenue details for one Billsby subscription.
>
> #### Input Parameters
>
> **subscription\_unique\_id** `string` *required*
>
> Billsby subscription unique ID, usually obtained from List Subscriptions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subscription Shipping Address
>
> **Slug:** `BILLSBY_GET_SUBSCRIPTION_SHIPPING_ADDRESS`
>
> Get the shipping address associated with one Billsby subscription.
>
> #### Input Parameters
>
> **subscription\_unique\_id** `string` *required*
>
> Billsby subscription unique ID whose shipping address should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **search** `string`
>
> Partial customer name to match. Omit to list all customers.
>
> **page\_size** `integer`
>
> Number of customers to request for this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page; the cursor retains the original search and page size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Subscriptions
>
> **Slug:** `BILLSBY_LIST_CUSTOMER_SUBSCRIPTIONS`
>
> List all subscriptions belonging to one Billsby customer.
>
> #### Input Parameters
>
> **customer\_unique\_id** `string` *required*
>
> Billsby customer unique ID whose subscriptions should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Product Plans
>
> **Slug:** `BILLSBY_LIST_PRODUCT_PLANS`
>
> List the plans and billing cycles configured for one Billsby product.
>
> #### Input Parameters
>
> **product\_id** `integer` *required*
>
> Billsby product ID, usually obtained from List Products.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `BILLSBY_LIST_PRODUCTS`
>
> Return one page of Billsby products, optionally filtered by name or visibility.
>
> #### Input Parameters
>
> **search** `string`
>
> Partial product name to match. Omit to list all products.
>
> **page\_size** `integer`
>
> Number of products to request for this page (1-100).
>
> **visibility** `integer`
>
> Billsby visibility code: 0 public, 1 hidden, 2 internal, or 3 off-sale.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call. Omit for the first page; the cursor retains the original filters and page size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscriptions
>
> **Slug:** `BILLSBY_LIST_SUBSCRIPTIONS`
>
> Return one page of company subscriptions with optional status, trial, product, plan, and ordering filters.
>
> #### Input Parameters
>
> **order\_by** `string`
>
> Subscription object property to order by. Billsby accepts any property using its provider casing, such as CreatedOn.
>
> **is\_active** `boolean`
>
> When set, filter by active status.
>
> **page\_size** `integer`
>
> Number of subscriptions to request for this page (1-100).
>
> **plan\_name** `string`
>
> Filter subscriptions by matching plan name.
>
> **next\_cursor** `string`
>
> 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`
>
> Filter subscriptions by matching product name.
>
> **is\_in\_free\_trial** `boolean`
>
> When set, filter by free-trial status.
>
> **order\_descending** `boolean`
>
> Whether to sort the order\_by property descending. Omit when order\_by is omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string` *required*
>
> Complete desired email address.
>
> **last\_name** `string` *required*
>
> Complete desired last name.
>
> **first\_name** `string` *required*
>
> Complete desired first name.
>
> **phone\_number** `string`
>
> Phone number without a leading zero, per Billsby documentation.
>
> **billing\_address** `object` *required*
>
> Complete desired billing address.
>
> **customer\_unique\_id** `string` *required*
>
> Billsby customer unique ID to update.
>
> **phone\_number\_dial\_code** `string`
>
> International phone dial code, such as +1.
>
> **phone\_number\_dial\_country** `string`
>
> Phone dial country, if the customer has a phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
