Skip to main content
Billsby logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: BILLSBY
  • Version: 00000000_00

Tools

Slug: BILLSBY_CREATE_CUSTOMERCreate a Billsby customer without a subscription or payment card. This does not start recurring billing.

Input Parameters

string
required
Customer email address.
string
required
Customer last name.
string
required
Customer first name.
object
required
Billing address for the new customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_GET_CUSTOMERGet billing, contact, payment-status, and account details for one Billsby customer.

Input Parameters

string
required
Billsby customer unique ID, usually obtained from List Customers or Create Customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_GET_SUBSCRIPTIONGet billing schedule, customer, product, plan, pricing, status, and revenue details for one Billsby subscription.

Input Parameters

string
required
Billsby subscription unique ID, usually obtained from List Subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_GET_SUBSCRIPTION_SHIPPING_ADDRESSGet the shipping address associated with one Billsby subscription.

Input Parameters

string
required
Billsby subscription unique ID whose shipping address should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_LIST_CUSTOMERSReturn one page of customers for the connected Billsby company, optionally filtered by a partial customer name.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_LIST_CUSTOMER_SUBSCRIPTIONSList all subscriptions belonging to one Billsby customer.

Input Parameters

string
required
Billsby customer unique ID whose subscriptions should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_LIST_PRODUCT_PLANSList the plans and billing cycles configured for one Billsby product.

Input Parameters

integer
required
Billsby product ID, usually obtained from List Products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_LIST_PRODUCTSReturn one page of Billsby products, optionally filtered by name or visibility.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_LIST_SUBSCRIPTIONSReturn one page of company subscriptions with optional status, trial, product, plan, and ordering filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BILLSBY_UPDATE_CUSTOMERReplace the editable contact and billing-address details for an existing Billsby customer. Supply the complete desired values, not a partial patch.

Input Parameters

string
required
Complete desired email address.
string
required
Complete desired last name.
string
required
Complete desired first name.
string
Phone number without a leading zero, per Billsby documentation.
object
required
Complete desired billing address.
string
required
Billsby customer unique ID to update.
string
International phone dial code, such as +1.
string
Phone dial country, if the customer has a phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not