Connectors
Chargebee
Connectors
Chargebee
Description
Chargebee provides subscription and recurring billing systems for SaaS and e-commerce businesses.
Connector Details
| Name | Value |
|---|---|
| Platform | Chargebee |
| Auth Type | API Keys |
| Direction | Read |
Supported Data
See the table below for the list of data you can read with the Chargebee connector.
| Table Name | Fields |
|---|---|
| events | id, occurred_at, source, user, event_type, api_version, object, webhook_status, content |
| coupons | id, name, invoice_name, discount_type, discount_percentage, discount_amount, currency_code, duration_type, duration_month, max_redemptions, status, apply_discount_on, apply_on, plan_constraint, addon_constraint, created_at, archived_at, resource_version, updated_at, object, redemptions, plan_ids, addon_ids, invoice_notes, meta_data |
| credit_notes | id, customer_id, subscription_id, reference_invoice_id, type, reason_code, status, fractional_correction, vat_number, date, price_type, currency_code, exchange_rate, total, amount_allocated, amount_refunded, amount_available, refunded_at, voided_at, resource_version, updated_at, sub_total, round_off_amount, deleted, business_entity_id, line_items, discounts, line_item_discounts, line_item_tiers, taxes, line_item_taxes, linked_refunds, allocations |
| customers | id, first_name, last_name, email, phone, company, vat_number, auto_collection, net_term_days, created_at, updated_at, locale, consolidated_invoicing, billing_date, billing_date_mode, billing_day_of_week, billing_day_of_week_mode, primary_payment_source_id, invoice_notes, promotional_credits, unbilled_charges, refundable_credits, excess_payments, deleted, cf_company_id, allow_direct_debit, card_status, object, pii_cleared, preferred_currency_code, taxability, business_entity_id, vat_number_validated_time, vat_number_status, is_location_valid, created_from_ip, entity_code, exempt_number, resource_version, fraud_flag, backup_payment_source_id, registered_for_gst, customer_type, meta_data, exemption_details, custom_fields, billing_address, referral_urls, contacts, payment_method, balances, relationship |
| gifts | id, status, scheduled_at, auto_claim, claim_expiry_date, resource_version, updated_at, gifter, gift_receiver, gift_timelines |
| invoices | id, po_number, customer_id, recurring, status, vat_number, price_type, date, due_date, net_term_days, currency_code, total, amount_paid, amount_adjusted, write_off_amount, credits_applied, amount_due, paid_at, dunning_status, next_retry_at, resource_version, voided_at, updated_at, sub_total, tax, first_invoice, has_advance_charges, expected_payment_date, amount_to_collect, round_off_amount, deleted, is_gifted, term_finalized, line_items, discounts, line_item_discounts, taxes, line_item_taxes, line_item_tiers, linked_payments, applied_credits, adjustment_credit_notes, issued_credit_notes, linked_orders, notes, shipping_address, billing_address, exchange_rate, base_currency_code, new_sales_amount, object, subscription_id, payment_owner, business_entity_id |
| orders | id, document_number, invoice_id, subscription_id, customer_id, status, cancellation_reason, payment_status, order_type, price_type, reference_id, fulfillment_status, order_date, shipping_date, note, tracking_id, batch_id, created_by, shipment_carrier, invoice_round_off_amount, tax, amount_paid, amount_adjusted, refundable_credits_issued, refundable_credits, rounding_adjustement, paid_on, shipping_cut_off_date, created_at, status_update_at, delivered_at, shipped_at, resource_version, updated_at, cancelled_at, discount, sub_total, total, deleted, currency_code, is_gifted, gift_note, gift_id, order_line_items, shipping_address, billing_address, line_item_taxes, line_item_discounts, linked_credit_notes |
| payment_sources | id, resource_version, updated_at, created_at, customer_id, type, reference_id, status, gateway, gateway_account_id, ip_address, issuing_country, deleted, object, card, business_entity_id, bank_account, amazon_payment, paypal |
| promotional_credits | id, customer_id, type, amount, currency_code, description, credit_type, reference, closing_balance, done_by, created_at |
| subscriptions | id, customer_id, currency_code, plan_id, plan_quantity, plan_unit_price, billing_period, mrr, billing_period_unit, status, coupon, trial_start, trial_end, current_term_start, current_term_end, next_billing_at, remaining_billing_cycles, po_number, created_at, started_at, activated_at, cancelled_at, cancel_reason, affiliate_token, updated_at, payment_source_id, auto_collection, start_date, invoice_notes, deleted, base_currency_code, due_invoices_count, exchange_rate, has_scheduled_changes, plan_amount, plan_free_quantity, resource_version, object, setup_fee, gift_id, pause_date, resume_date, created_from_ip, due_since, total_dues, meta_data, metadata, custom_fields, contract_term_billing_cycle_on_renewal, override_relationship, has_scheduled_advance_invoices, plan_free_quantity_in_decimal, plan_quantity_in_decimal, plan_unit_price_in_decimal, plan_amount_in_decimal, cancel_reason_code, free_period, free_period_unit, create_pending_invoices, auto_close_invoices, business_entity_id, addons, event_based_addons, charged_event_based_addons, coupons, shipping_address, referral_info, contract_term, subscription_items, item_tiers, charged_items |
| transactions | id, customer_id, subscription_id, gateway_account_id, payment_source_id, payment_method, reference_number, gateway, type, date, settled_at, currency_code, amount, id_at_gateway, status, fraud_flag, initiator_type, three_d_secure, error_code, error_text, validated_at, updated_at, fraud_reason, amount_unused, masked_card_number, reference_transaction_id, reversal_txn_id, deleted, exchange_rate, base_currency_code, resource_version, object, refunded_txn_id, authorization_reason, voided_at, reversal_transaction_id, reference_authorization_id, amount_capturable, business_entity_id, linked_invoices, linked_credit_notes, linked_refunds, linked_payments |
| virtual_bank_accounts | id, customer_id, email, bank_name, account_number, routing_number, swift_code, gateway, gateway_account_id, resource_version, updated_at, created_at, reference_id, deleted, object |
| unbilled_charges | id, customer_id, subscription_id, date_from, date_to, unit_amount, pricing_model, quantity, amount, currency_code, discount_amount, description, entity_type, entity_id, is_voided, voided_at, deleted, updated_at, tiers |
| invoiced_unbilled_charges | id, customer_id, subscription_id, date_from, date_to, unit_amount, pricing_model, quantity, amount, currency_code, discount_amount, description, entity_type, entity_id, is_voided, voided_at, deleted, updated_at, tiers |
| addons | id, name, invoice_name, description, pricing_model, charge_type, price, currency_code, period, period_unit, unit, status, archived_at, enabled_in_portal, tax_code, avalara_sale_type, avalara_transaction_type, avalara_service_type, sku, accounting_code, accouting_category1, accouting_category2, is_shippable, shipping_frequency_period, shipping_frequency_period_unit, resource_version, updated_at, invoice_notes, taxable, tax_profile_id, object, type, meta_data, custom_fields, tiers |
| plans | id, name, invoice_name, description, price, period, period_unit, trial_period, trial_period_unit, charge_model, free_quantity, setup_cost, status, archived_at, billing_cycles, redirect_url, sku, updated_at, invoice_notes, taxable, tax_profile_id, enabled_in_hosted_pages, enabled_in_portal, addon_applicability, tax_code, avalara_sale_type, avalara_transaction_type, avalara_service_type, account_code, accounting_category1, accounting_category2, is_shippable, currency_code, shipping_frequency_period, shipping_frequency_period_unit, resource_version, giftable, claim_url, meta_data, custom_fields, tiers, applicable_addons, event_based_addons |
| items | id, name, description, status, resource_version, updated_at, item_family_id, type, is_shippable, is_giftable, redirect_url, enabled_for_checkout, enabled_in_portal, included_in_mrr, item_applicability, gift_claim_redirect_url, unit, metered, usage_calculation, metadata, custom_fields, applicable_items |
| item_prices | id, name, item_family_id, item_id, description, status, external_name, pricing_model, price, period, currency_code, period_unit, trial_period, trial_period_unit, shipping_period_unit, billing_cycles, free_quantity, resource_version, updated_at, created_at, invoice_notes, is_taxable, metadata, item_type, show_description_in_invoices, show_description_in_quotes, tiers, tax_detail, accounting_detail |
Credentials Setup
Follow the steps below to get the credentials you need to use the Chargebee connector.
To obtain your Chargebee credentials, you must first login to Chargebee. If you don’t currently have an account, you can make a free one here.
Site Name
Once you do login, you should be greeted with a page similar to this. The first credential you will need for hotglue is your site name. You can find that in the top right hand corner of your screen.
Note: If you are using a testing account and/or sandbox, your site name will be yoursitename-test. You can see in the example above that the account we are connecting is a test account. If you are not sure if you have a test account, you can also check the url of your site. The beginning of the URL is also your site name.
API Key
The next credential you will need is your API key. From the home page, you should click the Settings dropdown from the navigation bar on the left hand side.
From the resulting drop down, you should select the Configure Chargebee tab.
On this page, scroll down until you get to the API Keys and Webhooks section. You should then click on the API keys option.
You will now be on a page where you can create new API Keys. You should go ahead and create a new key for hotglue. Do this by click on the Add API Key button.
You will now be asked what kind of key you want to create. You should go ahead and select the Full-Access Key option.
Now go ahead and name your key hotglue. Subsequently, you should click Create Key.
Now you have your API Key! Make sure to copy this into hotglue.