chargebee-typescript
Advanced tools
This is the typescript Library for integrating with Chargebee. Sign up for a Chargebee account here.
Install the latest version 2.x.x of the library with the following commands:
$ npm install chargebee-typescript@">=2"
Then import the library as:
import {ChargeBee} from 'chargebee-typescript';
var chargebee = new ChargeBee();
import {
ChargeBee,
_subscription
} from 'chargebee-typescript';
var chargebee = new ChargeBee();
chargebee.configure({site : "mannar-test",
api_key : "test___dev__2d2aopx6Dh6tzq5qI3FuV7TuWMbxaudy"});
chargebee.subscription.create({
plan_id : "basic",
auto_collection : "off",
billing_address : {
first_name : "John",
last_name : "Doe",
line1 : "PO Box 9999",
city : "Walnut",
state : "California",
zip : "91789",
country : "US"
},
customer : {
first_name : "John",
last_name : "Doe",
email : "john@user.com"
}
}).request(function(error,result) {
if(error){
//handle error
console.log(error);
}else{
console.log(`${result}`);
var subscription: typeof chargebee.subscription = result.subscription;
var customer: typeof chargebee.customer = result.customer;
var card: typeof chargebee.card = result.card;
var invoice: typeof chargebee.invoice = result.invoice;
var unbilled_charges: Array<typeof chargebee.unbilled_charge> = result.unbilled_charges;
}
});
import {
ChargeBee,
_subscription
} from 'chargebee-typescript';
var chargebee = new ChargeBee();
chargebee.configure({site : "mannar-test",
api_key : "test___dev__2d2aopx6Dh6tzq5qI3FuV7TuWMbxaudy"});
chargebee.subscription.list({
limit : 2,
plan_id : { in : ["basic","no-trial"] }
}).request(function(error,result) {
if(error){
//handle error
console.log(error);
}else{
for(var i = 0; i < result.list.length;i++){
var entry=result.list[i]
console.log(`${entry}`);
var subscription: typeof chargebee.subscription = entry.subscription;
var customer: typeof chargebee.customer = entry.customer;
var card: typeof chargebee.card = entry.card;
/*
For pagination: offset is the paramter that is being used.
The value used for this parameter must be the value returned for next_offset parameter in the previous API call.
usage: result.next_offset
*/
}
}
});
import {
ChargeBee,
_subscription
} from 'chargebee-typescript';
var chargebee = new ChargeBee();
chargebee.subscription.create({
plan_id : "basic"
}).param({
"cf_host_url" : "http://xyz.com",
"customer[cf_host_url]" : "http://xyz.com"
}).headers({
"chargebee-event-email" : "all-disabled", // To disable webhooks
"chargebee-request-origin-ip": "192.168.1.2"
}).request(function(error,result) {
if(error){
console.log(error);
}else{
var subscription = result.subscription
var customer = result.customer
console.log(subscription.cf_host_url);
console.log(customer.cf_host_url);
}
});
import {
ChargeBee,
_subscription
} from 'chargebee-typescript';
var chargebee = new ChargeBee();
//The callback function that you provide needs to take in two arguments. The first being error object and the
//second being the response. Incase of error, the error object is passed.
chargebee.subscription.create({
//create params...
}).request(function(error, result) {
if (error) {
handleCreateSubscriptionError(error);
} else {
console.log(result);
}
});
function handleCreateSubscriptionError(ex) {
if (ex.type == "payment") {
// First check for card parameters entered by the user.
// We recommend you to validate the input at the client side itself to catch simple mistakes.
if ("card[number]" == ex.param) {
// Ask your user to recheck the card number. A better way is to use
// Stripe's https://github.com/stripe/jquery.payment for validating it in the client side itself.
//}else if(<other card params> == ex.param){
//Similarly check for other card parameters entered by the user.
//....
} else {
// Verfication or processing failures.
// Provide a standard message to your user to recheck his card details or provide a different card.
// Like 'Sorry,there was a problem when processing your card, please check the details and try again'.
}
} else if (ex.type == "invalid_request") {
// For coupons you could decide to provide specific messages by using
// the 'api_error_code' attribute in the ex.
if ("coupon" == ex.param) {
if ("resource_not_found" == ex.api_error_code) {
// Inform user to recheck his coupon code.
} else if ("resource_limit_exhausted" == ex.api_error_code) {
// Inform user that the coupon code has expired.
} else if ("invalid_request" == ex.api_error_code) {
// Inform user that the coupon code is not applicable for his plan(/addons).
} else {
// Inform user to recheck his coupon code.
}
} else {
// Since you would have validated all other parameters on your side itself,
// this could probably be a bug in your code. Provide a generic message to your users.
}
} else if (ex.type == "operation_failed") {
// Indicates that the request parameters were right but the request couldn't be completed.
// The reasons might be "api_request_limit_exceeded" or could be due to an issue in ChargeBee side.
// These should occur very rarely and mostly be of temporary nature.
// You could ask your user to retry after some time.
} else if (ex.type == "io_error") {
// Handle IO exceptions such as connection timeout, request timeout etc.
// You could give a generic message to the customer retry after some time.
} else {
// These are unhandled exceptions (Could be due to a bug in your code or very rarely in client library).
// The errors from ChargeBee such as authentication failures will come here.
// You could ask users contact your support.
}
}
The full documentation can be found on the chargebee site here:
https://apidocs.chargebee.com/docs/api?lang=typescript
See the LICENSE file.
v2.0.5 (2020-11-16)
FAQs
A library in typescript for integrating with Chargebee.
The npm package chargebee-typescript receives a total of 23,756 weekly downloads. As such, chargebee-typescript popularity was classified as popular.
We found that chargebee-typescript demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.