Chargebee
Last updated
Was this helpful?
Last updated
Was this helpful?
Create Chargebee account
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
Chargebee Card Input
- use Chargebee Components to collect card details. Chargebee Components are iframe based input 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
.
Generate token
- generate token with data about card. Return token value in Card Token
state.
Clear token
- delete token from Card Token
state.
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.
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.
Get a list of all prices and item_id and return item_price_id.
Item ID
- text, required
. ID of Chargebee item.
List of prices
- List of things returned by API Call List item prices
, required
.
We have 4 actions with same name and different things.
The site name, for the your_site
field can be obtained from the link from your Chargebee page.
This API Call creates a new customer in Chargebee.
This API call return list of your customers.
Return information about customer.
Update data of customer excluding billing data.
This method is used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer.
Add a card payment source to a customer using Chargebee.js token
This API adds a Direct Debit payment source for a customer.
Returns a list of items satisfying all the conditions specified in the filter parameters below.
Retrieve an item resource.
An item price is a price point for an item.
Retrieve a specific item price.
Creates a new subscription for an existing customer in Chargebee.
Cancels the subscription.
Pausing a subscription will move the subscription from its current state to Paused state, and will stop all recurring actions.
This API is used to resume a paused subscription.
Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.
Retrieves a subscription.
Update card details.
Deletes a payment source.
Deletes the subscription resource.
Deletes the customer resource.
This actions generate special Chargebee sort query.
This action get a list of things where represent an bucket and using additional options ( read about ) generate correct query.
About Create customer fields see .
About List customers fields see .
About Retrieve Customer fields see .
About Update Customer ( No Billing ) fields see .
About Update Customer ( Billing Data ) fields see .
About Create a card payment source via token for customer fields see .
About Create a bank account payment source for customer fields see .
Abou List items fields see .
About Retrieve An Item fields see .
About List item prices fields see .
About Retrieve Item Price fields see .
About Create Subscription For Items fields see .
About Cancel subscription for items fields see .
About Pause subscribtion fields see .
About Resume subscribtion fields see .
About List subscribtions fields see .
About Retrieve subscribtion fields see .
About Update a card payment source fields see .
About Delete a payment source fields see .
About Delete a payment source fields see .
About Delete a payment source fields see .