API Changelog

Subscribe

Keep track of changes and upgrades to the Chargebee API. Recent changes to API V2 are listed below. Please mail us at support@chargebee.com for any queries. The 'Upcoming' section contains the changes that will be made to Chargebee API in 2 to 3 days from date of the posting.

2018-11-09

Entity type quote has been added.
Event types quote_created and quote_updated have been added.

2018-11-02

New resource 'Gift' with endpoints Create a gift , Retrieve a gift , Claim a gift , Cancel a gift and List gifts has been added.
New event types gift_scheduled, gift_unclaimed, gift_claimed, gift_expired and gift_cancelled have been added.
New endpoints Checkout gift and Claim gift have been added to Hosted page resource.
Input param redirect_url has been added in Manage payment sources and Collect now APIs.
Hosted page types checkout_gift and claim_gift have been added.
The attributes term_finalized and is_gifted have been added in Invoice attributes.
The attributes is_gifted, gift_note and gift_id have been added in Orders attributes.
The attribute sku has been added in Gift attributes.
The input parameter sku has been added in Update orders API.
The order status cancelled has been added.
The attributes giftable and claim_url have been added in Plan resource.
The input parameters giftable and claim_url have been added in Create a plan API.
List filter parameter giftable has been added in List Plans API.
The attribute gift_id has been added to Subscription resource.

2018-10-26

The attributes authorization_reason, reference_authorization_id, amount_capturable and linked_payments have been added in Transaction resource.
The input parameter transaction amount_capturable has been added in Export transaction API.
The input parameters authorization_transaction_id and auto_collection have been added in Create invoice API.
The input parameter authorization_transaction_id has been added in Collect payment for invoice API.
Type authorization_reason with values blocking_funds and verification has been added in Transaction resource.
New endpoints Create an authorization payment and Void an authorization transaction have been in added in Transaction API.
The input filter parameter amount_capturable has been added in List transactions API.
The Event types authorization_succeeded, authorization_voided, order_ready_to_process, order_ready_to_ship have been added.

2018-10-17

The attributes pricing_model and tiers have been added in Addon , Plan and UnbilledCharge resources.
The input parameters pricing_model, tier_starting_unit, tier_ending_unit and tier_price have been added in Create addon , Update addon , Create Plan and Update Plan APIs.
The attributes line_item_tiers has been added in creditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
The attribute pricing_model has been added to line_tem sub-resource of CreditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
The input parameter line_item_amount has been added in Create credit note API.
The input parameters line_item_unit_amount and line_item_quantity have been changed to optional parameters in Create Credit Note API.
The input parameter line_item_id, line_item_tier_line_item_id, line_item_tier_starting_unit, line_item_tier_ending_unit, line_item_tier_quantity_used, line_item_tier_unit_amount have been added in Import invoice API.
The attribute amount has been added to Addon subResource attributes of Subscription API.
The attribute plan_amount has been added to Subscription API.
The type pricing_model with values flat_fee, per_unit, tiered, volume and stairstep have been added.
The values tiered, volume and stairstep have been added to the attribute type of Addon resource.
The values tiered, volume and stairstep have been added to the attribute charge_model of Plan resource.
The input parameter type has been deprecated in Create Addon and Update Addon APIs.
The input parameter charge_model has been deprecated in Create Plan and Update Plan APIs.
The filter parameter type has been deprecated in List Addon API.
The filter parameter charge_model has been deprecated in List Plan API.
The filter parameter pricing_model has been added to List Plan and List Addon APIs.

2018-10-03

The attributes is_shippable, shipping_frequency_period and shipping_frequency_period_unit would be added in Plan and Addon resource.
The input parameters is_shippable, shipping_frequency_period and shipping_frequency_period_unit would be added in Create plan , Update plan , Create addon and Update addon APIs.
The attributes vat_number_validated_time, vat_number_status and is_location_valid would be added in Customer resource.
The event types order_created, order_updated, order_cancelled, order_delivered and order_returned would be added.
New order status queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered and returned would be added.
The input parameter subscription_affiliate_token would be added to Checkout New Hosted Pages API.
The attributes document_number and order_type would be added to Invoice resource.
The attributes document_number, customer_id, subscription_id, cancellation_reason, payment_status, order_type, price_type, order_date, shipping_date, shipment_carrier, invoice_round_off_amount, tax, amount_paid, amount_adjusted, refundable_credits_issued, refundable_credits, rounding_adjustement, paid_on, shipping_cut_off_date, delivered_at, shipped_at, resource_verison, updated_at, cancelled_at, order_line_items, shipping_address, billing_address, discount, sub_total, total, line_item_taxes, line_item_discounts, linked_credit_notes, deleted and currency_code would be added in Order resource.
The input parameters shipping_date, order_date, cancelled_at, cancellation_reason, shipped_at, delivered_at, shipment_carrier, shipping_address, order_line_item would be added in Update order API.
The filters include_deleted, shipping_date, order_date, paid_on and updated_at would be added in List Orders API.

2018-09-12

The attributes addon_applicability, applicable_addons, attached_addons and event_based_addons have been added to Plan resource.
The input parameters addon_applicability, applicable_addons, attached_addons and event_based_addons have been added in Create plan and Update plan APIs.
The attributes event_based_addons and charged_event_based_addons have been added to Subscription resource.
The input parameters event_based_addons and charged_event_based_addons have been added in Import subscription and Import subscription for customer APIs.

2018-08-17

New endpoint Merge customers has been added to Customer resource.
New endpoint Extend subscription has been added to Hosted page resource.
New endpoint Clear Personal Data of a customer has been added to Customer resource.
The input parameter charges_handling has been added to Resume a subscription and Resume subscription estimate APIs.
The input parameters pause_date and resume_date have been added to Import subscription and Import subscription for customer APIs.
New Tax exempt reason high_value_physical_goods has been added.

2018-06-21

New attribute round_off_amount has been added in Credit Note Estimate and Invoice Estimate sub resources.
New sort_by value updated_at has been added in List Invoice API.
New input parameter bank_account has been added in Create a customer and Create a subscription APIs.
New enums account_holder_type, account_type, echeck_type have been added to bank_account subscription resource in Payment Source resource.
New attributes echeck, account_holder_type, last4 have been added to bank_account subscription resource in Payment Source resource.
New API end point Retrieve Direct Debit Agreement PDF has been added in Hosted Page resource.
New API end points Create bank account payment source and Verify bank account payment source have been added to Payment source resource.

2018-05-23

New resource Exports has been added.
New gateway bluesnap has been added.

2018-05-14

New endpoint List of contacts for a customer has been added.

2018-05-03

New endpoint Update a coupon has been added.

2018-04-27

New resource Virtual Bank Account has been added.
New event types virtual_bank_account_added, virtual_bank_account_updated and virtual_bank_account_deleted have been added.
The payment method ach_credit has been added.

2018-03-29

New status pause has been added to Subscription and Subscription estimate status.
The attribues pause_date and resume_date have been added to Subscription and Estimate resources.
The attributes create_current_term_invoice, transaction amount, payment_method, reference_number and date have been added to Import a subscription and Import subscription for customer APIs.
The attribute expected_payment_date has been added to Invoice attributes.
The reason code subscription_pause has been added to Credit note attributes.
New event types subscription_paused, subscription_pause_scheduled, subscription_scheduled_pause_removed, subscription_resumed, subscription_resumption_scheduled and subscription_scheduled_resumption_removed have been added.

2018-03-20

New attribute deleted would be added to Payment source resource.

2018-03-08

The input parameter disposition_type has been added to Retrieve Invoice as PDF and Retrieve Credit Note as PDF APIs.

2018-03-02

The attribute balance_currency_code has been deprecated and attribute currency_code has been added to Balances sub-resource in Customer resource.
The attribute done_by has been added to Promotional credits resource.
New payment method wechat_pay has been added.
The endpoint Manage Payment Sources has been undeprecated in Hosted pages resource.

2018-02-01

The attribute round_off_amount have been added to Invoice and Credit note resources.
The attribute settled_at has been added to the Transaction resource.
Collect now API in the Hosted pages resource has been undeprecated.

2018-01-24

New Gateway enum type moneris and moneris_us has been added.

2018-01-12

New endpoint Update invoice details has been added to the Invoices resource.

2017-12-20

New input attribute payment_method_issuing_country has been released in create a customer , update payment method for a customer , create a subscription , update a subscription API
New input attribute issuing_country has been released in create using temporary token and create using permanent token API

2017-12-15

New Event Type subscription_changes_scheduled, subscription_scheduled_changes_removed and pending_invoice_updated has been released
New Gateway Type orbital has been released

2017-11-28

New resource Promotional Credits has been released
New sub resource balances has been added to customer resource
The API end point add_promotional_credits, deduct_promotional_credits and set_promotional_credits has been deprecated in customer resource
New Event Type promotional_credits_added and promotional_credits_deducted has been added

2017-11-14

The new resource Coupon Set has been added
The attribute coupon_set_id has been added to Coupon Code resource
New event type coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_updated, coupon_codes_deleted
The API end point create a coupon code for a couponhas been deprecated in coupon code resource
The deprecation has been removed for Collect payment for customer in customer resource
New end point Manage payment source and Collect now has been added as deprecated API to hosted page . Please mail us at support@chargebee.com  to enable
New attribute remaining_billing_cycles has been added in addons under subscription resource.

2017-09-28

The deprecation has been removed from parameter vat_number in Hosted pages Checkout new and Checkout existing APIs.
The parameter gateway_meta_data type has been changed to Json in Update a card payment source API.

2017-09-22

New endpoint Collect payment for a customer has been added to Customer as a restricted and deprecated API. Please mail us at support@chargebee.com  to enable.
The attribute amount_to_collect has been added to Invoice resource.

2017-09-15

The attribute payment_source_id has been added to the transaction resource.
The filter parameter payment_source_id has been added in List transactions API.
The gateway types amazon_payments and paypal_express_checkout has been added.

2017-09-14

The attribute registered_for_gst has been added to the Customer resource.

2017-09-06

The new endpoint Record refund for a credit note has been added to Credit note resource.
The parameter tmp_token has been deprecated in card subresource in Create a customer , Create a subscription , Update a subscription and Import subscription APIs.
The parameter tmp_token has been added to payment method subresource in Create a subscription API.
The type apple_pay has been added to payment method types.

2017-08-31

The parameters credit_option_for_current_term_charges, unbilled_charges_option, refundable_credits_handlingand account_receivables_handling have been added in Cancel subscription API.
A new endpoint Cancel subscription estimate has been added to the Estimate resource.
The attribute deleted has been added to the Unbilled charge resource.
The attribute include_delted has been added to the List unbilled charges API.

2017-08-16

A new endpoint Update a card payment source has been added to the Payment source resource.

2017-08-03

2017-07-26

The new resource Time Machine has been added.

2017-07-21

The new endpoint Change Billing Date has been added to Customer resource.
The new endpoints Upcoming invoices estimate and Subscription change term end estimate have been added to Estimate API.
The attributes billing_date, billing_date_mode, billing_day_of_week, billing_day_of_week_mode, unbilled_charges have been added to the Customer resource.
The parameters line_item_date_from and line_item_date_to have been added to Add Charge API.
The parameters prorate and invoice_immediately have been added Change term end API.

2017-07-06

The parameter status has been added to the Create a plan , Create an addon and Create a coupon APIs.
The attribute issuing_country has been added to the Card and Payment source resource.
The reason code fraudulent has been added to the Credit note resource.
The attribute bank_name is made optional in Bank Account subresource.
The parameter redirect_url has been made optional in Create a portal session API.
The attributes fraud_flag and fraud_reason have been added to the Transaction resource.

2017-06-01

The endpoint Create an estimate for Unbilled charges has been added to the Unbilled Charge resource.
The filter param phone has been added to the List Customer API.
The list subresource invoice_estimates has been added to the Estimate resource.

2017-05-04

The new resources Payment Source and Unbilled Charge have been added.
The attribute payment_source_id has been added to the Card resource.
The attribute subscription_id has been added to the lineitems subresource in Invoice , Credit Note , Invoice estimate , Next invoice estimate and Credit Note estimate .
The attributes consolidated_invoicing, primary_payment_source_id, backup_payment_source_id and the subresource list referral_urls have been added to the Customer resource.
The attributes payment_source_id and auto_collection have been added to the Subscription resource.
The subresource unbilled_charge_estimates has been added to the Estimate resource.
The param consolidated_invoicing has been added to Create a customer and Update a customer APIs.
The endpoint Assign payment role has been added to the Customer resource.
The endpoint Override Billing Profile has been added to the Subscription resource.
The input params auto_collection, invoice_immediately and consolidated_invoicing have been added to Create subscription API.
The input params auto_collection, payment_source_id and invoice_immediately have been added to Create subscription for customer API.
The input param auto_collection has been added to the Subscription subresource and consolidated_invoicing has been added to the Customer subresource in Checkout new subscription API.
The event types payment_source_added, payment_source_updated and payment_source_deleted have been added.

2017-04-19

The endpoints List and Acknowledge APIs have been added to the Hosted page resource.
A new subresource line_item_discounts has been added to the Invoice , Credit note , Invoice estimates and Credit note estimates resources.
The Card statuses pending_verification and invalid have been added to the Customer resource.
The Payment Method types generic, alipay and unionpay have been added to the Payment Method type in the Customer resource.
The state failed and the attribute failure_reason have been deprecated in the Hosted Page resource.
The attribues updated_at, resource_version and checkout_info have been added to the Hosted Page resource.
A new gateway adyen has been added.

2017-03-16

The input parameter id has been removed in Update a Plan and Update an addon resources.
The filter input parameter next_billing_at has been added in List Subscriptions API.
The input parameter force_term_reset has been added to Checkout existing hosted pages API.
A new attribute has_advance_charges has been added to the Invoice resource.

2017-02-24

New resources Site Migration Details and Resource Migrations have been added.
The attributes id and for_site_merging have been added to Copy an addon , Copy a coupon and Copy a plan API.
A new endpoint Move a customer has been added.
The event types customer_moved_out and customer_moved_in have been added.
The input parameters ignore_scheduled_cancellation and ignore_scheduled_changes have been added to the Subscription renewal estimate API.

2017-01-30

A new reason code Subscription cancellation has been added to the Credit note resource.
A new attribute next_billing_at has been added to the Subscription resource.
The input parameters terms_to_charge, reactivate, reactivate_from have been added to Update a Subscription , Update subscription estimate and Checkout existing hosted page APIs.
The input parameter reactivate_from has been added to Reactivate a subscription API.
A new endpoint Charge Future Renewals has been added to the Subscription API.

2017-01-27

A new attribute gateway_account_id has been added to Card resource. A input param gateway has been deprecated and a new input param gateway_account_id has been added to Update card for customer , Switch gateway and Copy card APIs.
An input param gateway has been deprecated and a new input param gateway_account_id has been added to Card and Payment method sub resource in Create a customer , Create a subscription , Update a subscription and Import subscription API.
An input param fraud_flag has been added to Update customer API.
An input param gateway has been deprecated and a new input param gateway_account_id has been added to Payment method sub resource in Update payment method for a customer API.
An input param gateway has been deprecated and a new input param gateway_account_id has been added to the Card resource in Checkout new , Checkout existing and Update Payment method Hosted Page APIs.
New input params billing_address and shipping_address has been added to Checkout new hosted page API.
A new endpoint Create subscription for a customer estimate has been added to the Estimate resource.

2017-01-12

A new endpoint Unarchive a plan has been added to the Plan resource.
A new endpoint Unarchive an addon has been added to the Addon resource.
A new endpoint Unarchive a coupon has been added to the Coupon resource.

2016-12-30

The attributes plan_unit_price, setup_fee, billing_period, billing_period_unit and plan_free_quantity have been added to the Subscription resource.
An input parameter Addon unit_price has been added to Charge addon at term end, Create an Invoice , Create invoice for addon and Add addon item to pending invoice APIs.

2016-12-09

A new attribute, locale has been added to the Customer resource.
The attributes mrr, exchange_rate and base_currency_code have been added to the Subscription resource.
A new filter parameter cancelled_at has been added to List Subscription API.
The attribute voided_at has been added to the Invoice and the Credit Note resource and voided_at filter has been added to List invoices and List credit notes APIs.
The attributes sku, accounting_code, accounting_category1 and accounting_category2 have been added to the Plan and the Addon resource.
The input parameters sku, accounting_code, accounting_category1 and accounting_category2 have been added to Create a plan , Update a plan , Create an addon and Update an addon APIs.
The input parameters transaction_id_at_gateway, transaction_status, transaction_error_code and transaction_error_text have been added to Record an invoice payment API.

2016-11-24

A new attribute, funding_type has been added to Card resource.
A new endpoint, List coupon codes API has been added to Coupon Code resource.
A new endpoint, Copy a plan API has been added to Plan resource.
A new endpoint, Copy an addon API has been added to Addon resource.
A new endpoint, Copy a coupon API has been added to Coupon resource.
A new endpoint, Import a subscription and Import Subscription for customer APIs have been added to Subscription resource.
A new endpoint, Import invoice API has been added to Invoice resource.

2016-11-18

The attribute tax_profile_id will be added to Plan , and Addon resources.
A new input parameter, tax_profile_id will be added to Create plan , Update a plan , Create an addon , and Update an addon APIs.
A new Subscription cancel reason type non_compliant_customer will be added. Refer to Subscription attributes for more information.

2016-11-09

The attributes updated_at and resource_version have been added to Plan , Addon , and Coupon resources.
The following Event Types have been introduced: plan_created, plan_updated, plan_deleted, addon_created, addon_updated, addon_deleted, coupon_created, coupon_updated, coupon_deleted, netd_payment_due_reminder.
The new Invoice status posted has been added. Refer to Invoice attributes for more information.
The attribute net_term_days has been added to the Customer resource and a new input parameter net_term_days has been added to Create a customer , Update a customer , and Create a Subscription APIs.
The attributes net_term_days and due_date have been added to the Invoice resource.

2016-10-27

The attribute preferred_currency_code has been added to the Customer resource. A new input parameter preferred_currency_code has been added to Create a customer and Update a customer APIs.

2016-10-07

The parameter coupon has been deprecated and an alternate new parameter coupon_ids has been added to Create a Subscription , Create subscription for customer , Update Subscription , Create subscription estimate , and Update subscription estimate APIs.
Two new parameters force_term_reset and replace_coupon_list have been added to Update a subscription and Update subscription estimate APIs.

2016-09-30

The new attributes updated_at, resource_version, and deleted will be returned as part of Customer , Subscription , Invoice , Credit Note , and Transaction resources.
A new parameter, include_deleted has been added to Customer , Subscription , Invoice , Credit Note , and Transaction List APIs.
A new parameter, date has been added to Create Credit Note API.

2016-09-21

A new Gateway type gocardless has been added for Card resource.

2016-09-03

A new endpoint to Create Credit Note has been added.
A new endpoint to Write off an invoice has been added.
A new input parameter forward_url has been added for Create a portal session API.

2016-08-25

The attribute validation_status has been added to address .
The attribute validation_status has been added to billing address of Customer resource and the attribute fraud_flag will now be returned in Customer in case of any fraudulent transactions. The APIs Create a Customer , Update Billing Info for a Customer will take in validation_status as input parameter for address objects.
The attribute validation_status has been added to Subscription 's shipping address. The APIs Create a subscription , Create Subscription for customer , and Update subscription will now take in validation_status for address objects.
The attribute validation_status will be returned as part of billing and shipping address in Invoice resource.
The attribute created_from_ip, card_ip_address has been deprecated from Customer and Subscription resource.
The input parameter tmp_token has been added to Payment Method subresource that can be used in Create a customer and Update payment method for a customer APIs for direct_debit type through Stripe gateway.
The status pending_verification has been added to the subresource attribute Payment Method status.

2016-08-02

A new endpoint Retrieve Credit Note as PDF has been added.
The attribute invoice_notes has been added to subscription in Hosted Pages Checkout new and Checkout existing APIs.
The filter parameter paid_at has been added to List invoices API and the parameter paid_on_after has been deprecated.
The filter parameters occurred_at, webhook_status, and event_type have been added to List events and the parameters start_time, end_time, webhook_status, and event_type have been deprecated.

2016-07-18

A new endpoint Remove coupons has been added.
A new endpoint Record an excess payment for a customer has been added.

2016-07-06

A new endpoint Delete a coupon has been added.

2016-07-04

The attribute currency_code has been added as part of Plans , Addons , Coupons , Subscription , Transaction , and Estimate resources.

2016-06-27

A new resource third_party_payment_method will be returned on performing Copy card API.

2016-06-16

A new subresource next_invoice_estimate will be returned as part of the Estimate resource.

2016-05-24

A new attribute currency_code will be returned as part of the Credit Note resource.
A new Gateway type wepay has been added for the Card resource.