Chargebee
Introduction
How to setup
Create Chargebee account https://www.chargebee.com/trial-signup/
Go to Settings -> Configure Chargebee
3. Go to API keys
4. Press Add API Key
5. Create Full-Access Key
6. Set the name of API Key
7. Copy API Key
8. Place this API Key in Plugin fields
Plugin Element Proprietes
Chargebee Card Input - use Chargebee Components to collect card details. Chargebee Components are iframe based input fields.
Element fields
Site - text, Required.
Your Site name. The site name can be obtained from the link from your Chargebee page.
Domain - text, Required if custom domain is enabled.
Your custom domain. Example: https://billing.yourdomain.com
Number - text. Optional.
Custom text for card number placeholder.
Expiry - text. Optional.
Custom text for card expiry placeholder.
CVV - text. Optional.
Custom text for card cvv expiry placeholder.
Placeholder Color - color. Optional.
Color of placeholder text.
Icon Color - color. Optional.
Color of card image in input.
publishableKey - text. Required.
How to get Publishable Key:
Go to Settings -> Configure Chargebee
3. Go to API keys
4. Press Add API Key
5. Crate Publishable Key
6. Check all checkboxes and set name for this key
7. Copy this key and put it in element field
Type - Fields mode or Default mode. Required.
Element actions
Generate token - generate token with data about card. Return token value in Card Token state.
Clear token - delete token from Card Token state.
Element events
Token Is Generated - is triggered when action Generate token is executed and token is writen in Card Token state.
Error In Token Generation - is triggered when action Generate token have an error. Error text is writen in Token Generation Error state.
Error in input - is triggered when an input value is not valid. Error text is writen in Error in input state.
Element states
Card Token - contains token generated by action Generate token.
Token Generation Error - contains error text in token generation.
Error in input - contains error text from invalid input.
Plugin actions
ChargeBee - Get Item Price
Get a list of all prices and item_id and return item_price_id.
Fields
Item ID - text, required. ID of Chargebee item.
List of prices - List of things returned by API Call List item prices , required.
ChargeBee - Generate Sort Query For ...
We have 4 actions with same name and different things.
This actions generate special Chargebee sort query. Chargebee filtering info.
ChargeBee - Generate Query For Buing
This action get a list of things where represent an bucket and using additional options ( read about Buy query ) generate correct query.
Plugin API Calls
The site name, for the your_site field can be obtained from the link from your Chargebee page.
Create customer
This API Call creates a new customer in Chargebee.
About Create customer fields see Chargebee docs.
List customers
This API call return list of your customers.
About List customers fields see Chargebee docs.
Retrieve Customer
Return information about customer.
About Retrieve Customer fields see Chargebee docs.
Update Customer ( No Billing )
Update data of customer excluding billing data.
About Update Customer ( No Billing ) fields see Chargebee docs.
Update Customer ( Billing Data )
This method is used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer.
About Update Customer ( Billing Data ) fields see Chargebee docs.
Create a card payment source via token for customer
Add a card payment source to a customer using Chargebee.js token
About Create a card payment source via token for customer fields see Chargebee docs.
Create a bank account payment source for customer
This API adds a Direct Debit payment source for a customer.
About Create a bank account payment source for customer fields see Chargebee docs.
List items
Returns a list of items satisfying all the conditions specified in the filter parameters below.
Abou List items fields see Chargebee docs.
Retrieve An Item
Retrieve an item resource.
About Retrieve An Item fields see Chargebee docs.
List item prices
An item price is a price point for an item.
About List item prices fields see Chargebee docs.
Retrieve Item Price
Retrieve a specific item price.
About Retrieve Item Price fields see Chargebee docs.
Create Subscription For Items
Creates a new subscription for an existing customer in Chargebee.
About Create Subscription For Items fields see Chargebee docs.
Cancel subscription for items
Cancels the subscription.
About Cancel subscription for items fields see Chargebee docs.
Pause subscribtion
Pausing a subscription will move the subscription from its current state to Paused state, and will stop all recurring actions.
About Pause subscribtion fields see Chargebee docs.
Resume subscribtion
This API is used to resume a paused subscription.
About Resume subscribtion fields see Chargebee docs.
List subscribtions
Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.
About List subscribtions fields see Chargebee docs.
Retrieve subscribtion
Retrieves a subscription.
About Retrieve subscribtion fields see Chargebee docs.
Update a card payment source
Update card details.
About Update a card payment source fields see Chargebee docs.
Delete a payment source
Deletes a payment source.
About Delete a payment source fields see Chargebee docs.
Delete subscription
Deletes the subscription resource.
About Delete a payment source fields see Chargebee docs.
Delete customer
Deletes the customer resource.
About Delete a payment source fields see Chargebee docs.
Last updated
Was this helpful?