Chargebee

Chargebee integration (Finance). Imported from open-connector.

API key9 toolshttps://{site}.chargebee.com/api/v2

GET

chargebee_list_customers

List Chargebee customers with optional exact-match filters and pagination.

/customers

10 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of records Chargebee should return.
offset	string	optional	The next_offset value returned by a previous Chargebee list call.
id	string	optional	A Chargebee resource identifier.
customerId	string	optional	A Chargebee resource identifier.
subscriptionId	string	optional	A Chargebee resource identifier.
email	string	optional	Filter customers whose email exactly matches this value.
status	string	optional	Filter resources whose status exactly matches this value.
itemId	string	optional	A Chargebee resource identifier.
sortBy	string	optional	The Chargebee field to sort by.
sortOrder	string	optional	The sort direction.

GET

chargebee_get_customer

Retrieve one Chargebee customer by ID.

/customers/{customerId}

1 parameter

Param	Type	Required	Description
customerId	string	required	A Chargebee resource identifier.

POST

chargebee_create_customer

Create a basic Chargebee customer record from JSON-friendly fields.

/customers

9 parameters

Param	Type	Required	Description
firstName	string	optional	Input field mapped to wire key via bodyTransform.
lastName	string	optional	Input field mapped to wire key via bodyTransform.
vatNumber	string	optional	Input field mapped to wire key via bodyTransform.
autoCollection	string	optional	Input field mapped to wire key via bodyTransform.
netTermDays	integer	optional	Net term days for the customer.
id	string	optional	Chargebee customer id.
email	string	optional	Chargebee customer email.
phone	string	optional	Chargebee customer phone.
company	string	optional	Chargebee customer company.

GET

chargebee_list_subscriptions

List Chargebee subscriptions with optional exact-match filters and pagination.

/subscriptions

10 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of records Chargebee should return.
offset	string	optional	The next_offset value returned by a previous Chargebee list call.
id	string	optional	A Chargebee resource identifier.
customerId	string	optional	A Chargebee resource identifier.
subscriptionId	string	optional	A Chargebee resource identifier.
email	string	optional	Filter customers whose email exactly matches this value.
status	string	optional	Filter resources whose status exactly matches this value.
itemId	string	optional	A Chargebee resource identifier.
sortBy	string	optional	The Chargebee field to sort by.
sortOrder	string	optional	The sort direction.

GET

chargebee_get_subscription

Retrieve one Chargebee subscription by ID.

/subscriptions/{subscriptionId}

1 parameter

Param	Type	Required	Description
subscriptionId	string	required	A Chargebee resource identifier.

GET

chargebee_list_invoices

List Chargebee invoices with optional exact-match filters and pagination.

/invoices

10 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of records Chargebee should return.
offset	string	optional	The next_offset value returned by a previous Chargebee list call.
id	string	optional	A Chargebee resource identifier.
customerId	string	optional	A Chargebee resource identifier.
subscriptionId	string	optional	A Chargebee resource identifier.
email	string	optional	Filter customers whose email exactly matches this value.
status	string	optional	Filter resources whose status exactly matches this value.
itemId	string	optional	A Chargebee resource identifier.
sortBy	string	optional	The Chargebee field to sort by.
sortOrder	string	optional	The sort direction.

GET

chargebee_get_invoice

Retrieve one Chargebee invoice by ID.

/invoices/{invoiceId}

1 parameter

Param	Type	Required	Description
invoiceId	string	required	A Chargebee resource identifier.

GET

chargebee_list_item_prices

List Chargebee item prices with optional exact-match filters and pagination.

/item_prices

10 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of records Chargebee should return.
offset	string	optional	The next_offset value returned by a previous Chargebee list call.
id	string	optional	A Chargebee resource identifier.
customerId	string	optional	A Chargebee resource identifier.
subscriptionId	string	optional	A Chargebee resource identifier.
email	string	optional	Filter customers whose email exactly matches this value.
status	string	optional	Filter resources whose status exactly matches this value.
itemId	string	optional	A Chargebee resource identifier.
sortBy	string	optional	The Chargebee field to sort by.
sortOrder	string	optional	The sort direction.

GET

chargebee_get_item_price

Retrieve one Chargebee item price by ID.

/item_prices/{itemPriceId}

1 parameter

Param	Type	Required	Description
itemPriceId	string	required	A Chargebee resource identifier.