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.

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.