chargebee

---

• New attribute client_profile_id has been added in customer resource.
• New input parameter client_profile_id has been added in create_a_customer, update_a_customer, create_subscription_estimate, create_a_subscription and import_a_subscription api.
• New input parameter payment_intent has been added in create_a_gift, create_an_invoice, reactivate_a_subscription and resume_a_subscription api.
• New input parameter replace_primary_payment_source has been added in create_an_invoice api.
• New attribute currency_code has been added in payment_intent resource.

---

• New resource payment_intent has been added.
• New input parameter 'id' in payment_intent sub-param has been added in create_a_customer, collect_payment_for_customer, create_using_payment_intent, create_a_subscription, create_subscription_for_customer and update_a_subscription .
• New event_types PAYMENT_INTENT_CREATED and PAYMENT_INTENT_UPDATED have been added.

---

• New attributes tax_amount_in_local_currency and local_currency_code have been added in line_item_tax sub-resource of credit_note, credit_note_estimate, invoice, invoice_estimate, order and quote resources.
• New attributes sub_total_in_local_currency, total_in_local_currency and local_currency_code have been added in credit_note and invoice resources.
• New input parameter gw_payment_method_id has been added in create_a_customer, collect_payment_for_customer, create_using_payment_intent, create_a_subscription, create_subscription_for_customer and update_a_subscription api.
• New attributes name, invoice_id and notes have been added in quote resource.
• New input parameters name, notes and expires_at have been added in create_a_quote_for_a_new_subscription, create_a_quote_for_update_subscription and create_a_quote_for_one-time_charges api.
• New input parameters id, auto_collection and po_number have been added in convert_a_quote api.

---

• The attribute ref_tx_id has been added in card resource.
• The attribute custmer_id has been added in credit_note_estimate and invoice_estimate resource.
• The input parameters payment_intent with gateway_account_id and gw_token have been added in create a customer, collect payment for customer, create subscription and create subscription for customer API.
• New enum dunning_type has been added.
• New value vantiv has been added in the gateway enum.
• New value sepa_credit has been added in payment method enum.
• The attribute dunning_attempts has been added in invoice resource.
• New enpoint create_using_payment_intent has been added in payment_source resouce.
• The input parameter reference_transaction has been added in update card payment source API.
• New endpoint list quote has been added in qoutes resource.
• The attributes initiator_type and three_d_secure have been added in transaction resource.
• New attribute scheme has been added in virtual_bank_account resource.
• New input parameter scheme has been added in create a virtual bank account using permanent token and create a virtual bank account API.

---

• The resources hierarchy and token are added.
• Value ‘day’ is added in period_unit and shipping_frequency_period_unit .
• The parameters fractional_correction, comment, date_from and date_to are added in Create credit note API.
• The attribute customer_id is added to line_item sub resource of Credit note, Credit note estimate, Invoice, Invoice estimate and Quote.
• Endpoints Link a customer, Delink a customer, Get hierarchy, CreateUsingToken are added.
• The attributes business_customer_without_vat_number and relationship are added to customer resource.
• The filter parameters parent_id, payment_owner_id, invoice_owner_id are added in List customers, Export revenue recognition reports, Export Deferred Revenue Reports and Export customers APIs.
• The parameter token_id is added in Collect payment API.
• Event types hierarchy_created, hierarchy_deleted, token_created, token_consumed and token_expired are added.
• The parameter service_period_in_days is added in Create subscription estimate, Create subscription for customer estimate, Update subscription estimate, Checkout new, Checkout existing, Create subscription for customer quote, Update subscription quote, Create subscription, Create subscription for customer, Update subscription, Import subscription and Import subscription for customer.
• The filter parameter payment_owner is added in Export revenue recognition reports,Export Deferred Revenue Reports, Export Invoice and List Invoice APIs.
• The attribute payment_owner is added to invoice.
• The attributes date_from and date_to are added to Create an invoice, create a invoice for add-on and create a invoice for charge,Create a quote for one-time charges, Add charge at term end and Add add-on at term end.
• The parameter comment is added to Stop dunning, Apply payments, Apply credits, Add charge, Add add-on charge, Update details and Close Invoice APIs.
• The parameter ‘claim_credits’ is added to delete invoice API.
• The attribute override_relationship is added to subscription resource.
• The parameter token_id is added to Create subscription API.
• The parameter override_relationship is added to Create subscription for customer and Update subscription APIs.
• The attribute service_period_in_days is added to event add ons sub resource.

---

• The attributes avalara_sale_type, avalara_transaction_type and avalara_service_type are added in Addon and plan resource.
• The input parameters avalara_sale_type, avalara_transaction_type , avalara_service_type are added in create addon , update addon ,create plan , update plan, create invoice , create invoice for charge, add_charge , add_charge_at_term_end and create_for_onetime_charges api endpoints.
• The attributes is_partial_tax_applied, is_non_compliance_tax and taxable_amount are added in line_item_taxes of credit_note ,credit_note_estimate , invoice, invoice_estimate , quote and order resources.
• The attributes exemption_details and customer_type are added in customer resource .
• The input parameters exemption_details and customer_type are added in create customer, update customer , create subscription estimate, create subscription and import subscription api endpoints.
• The enum values federal and unincorporated are added in tax_juris_type.
• The enum value export is added in tax_override_reason .
• The input parameter cancelled_at is added in cancel order api endpoint.
• New endpoint delete_local is added in payment_source and virtual_bank_account resources.

---

• The attributes created_at, resource_version and updated_at are added in card, payment_source and virtual_bank_account resources.
• The input filter parameter sort_by with updated_at attribute is added in list customer and list subscription api endpoints.
• New endpoint export orders is added in export resource.
• New endpoint accept quote is added in hosted_pages resource.
• The input filter parameters updated_at and created_at are added in list payment_source api endpoint and list virtual_bank_accounts endpoint .
• New endpoint delete an offline transaction is added in transaction resource.

---

• New event type 'quote_deleted' has been added
• New gateway type 'cybersource' has been added.
• New filter parameters 'subscription_id' and 'order_type' have been added in List Order API.
• New endpoints Create subscription for customer quote, Update subscription quote and Delete have been added to Quote resource.

---

• New resource 'Quote' with endpoints 'Retrieve a quote', 'Create a quote for one-time charges', 'Convert a quote', 'Update quote status', 'Retrieve quote as PDF' has been added. See : https://apidocs.chargebee.com/docs/api/quotes
• Entity type 'quote' has been added.
• Event types 'quote_created' and 'quote_updated' have been added.

---

• 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.

---

• 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.

---

• The attributes pricing_model and tiers has been added in Addon , Plan and UnbilledCharge resources.
• The attribute price is made optional in Plan and Addon resource.
• 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 would be added in creditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
• The attribute pricing_model have 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 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.

---

• The attributes is_shippable, shipping_frequency_period andshipping_frequency_period_unit has been added in Plan and Addon resource.
• The input parameters is_shippable, shipping_frequency_period andshipping_frequency_period_unit has been added in Create plan , Update plan , Create addonand Update addon APIs.
• The attributes vat_number_validated_time, vat_number_status and is_location_validhas been added in Customer resource.
• The event types order_created, order_updated, order_cancelled, order_deliveredand order_returned has been added.
• New order status queued, awaiting_shipment, on_hold, delivered, shipped,partially_delivered and returned has been added.
• New endpoints Export plans , Export addons , Export coupons , Export customers , Export subscriptions , Export invoices , Export creditnotes and Export transactions has been added to Exportst API.
• The input parameter subscription_affiliate_token has been added to Checkout New Hosted Pages API.
• The attributes document_number and order_type has been 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 andcurrency_code has been 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 has been added in Update order API.
• The filters include_deleted, shipping_date, order_date, paid_on and updated_at has been added in List Orders API.
• New endpoints Assign order number , Cancel an order , Create a refundable credit note and Reopen a cancelled order has been added to Orders API.

---

• The attributes addon_applicability, applicable_addons, attached_addons and event_based_addons has been added to Plan resource.
• The input parameters addon_applicability, applicable_addons, attached_addons and event_based_addons has been added in Create and Update plan APIs.
• The attributes event_based_addons and charged_event_based_addons has been added to Subscription resource.
• The input parameters mandatory_addons_to_remove, event_based_addons and charged_event_based_addons has been added in Create subscription, Create subscription for customer, Update subscription, Create subscription estimate, create subscription for customer estimate, update subscription estimate, checkout new subscription and checkout existing subscription APIs.

---

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

---

• New attribute round_off_amount is added in Credit Note Estimate, Invoice Estimate Object
• Sort List Invoice API results based on invoice updated_at attribute.
• Create Customer and Create Subscription additionally take bank account details as input parameter.
• New API end point in Hosted Page resource to retrieve direct debit agreement payment PDF
• New Enum AccountHolderType, AccountType, Echeck Type has been added in Payment Source
• New attribute echeck, account_holder_type, last4 has been added
• New API end points create bank account payment source and verify bank account payment source has been added

---

• New Resource Export has been added
• New payment gateway bluesnap has been added

---

New endpoint 'List contacts for a customer' has been added to Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#list_of_contacts_for_a_customer

---

New endpoint 'Update a coupon' has been added. See : https://apidocs.chargebee.com/docs/api/coupons#update_a_coupon

---

New resource 'Virtual Bank Account' has been added. See : https://apidocs.chargebee.com/docs/api/virtual_bank_accounts

New event types virtual_bank_account_added, virtual_bank_account_updated and virtual_bank_account_deleted has been added. See : https://apidocs.chargebee.com/docs/api/events#event_types

The payment method ach_credit has been added. See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes

---

New status 'Pause' has been added to subscription. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_status

The attribues 'pause_date' and 'resume_date' have been added to subscription and estimate resources. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The input params '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. See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription

The attribute 'expected_payment_date' has been added to Invoice attributes. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The reason code 'subscription_pause' has been added to Credit note attributes. See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_reason_code

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. See : https://apidocs.chargebee.com/docs/api/events#event_types

New endpoints 'Pause a subscription', 'Resume a subscription', 'Remove scheduled pause' and 'Remove scheduled resumption' have been added to Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions

New endpoints 'Pause subscription estimate' and 'Resume subscription estimate' have been added to Estimate resource. See : https://apidocs.chargebee.com/docs/api/estimates

---

New attribute 'deleted' has been added to Payment source resource. See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_attributes

---

The input parameter disposition_type has been added to 'Retrieve Invoice as PDF' and 'Retrieve Credit Note as PDF' APIs. See : https://apidocs.chargebee.com/docs/api/invoices#retrieve_invoice_as_pdf

---

The attribute 'balance_currency_code' has been deprecated and attribute 'currency_code' has been added to Balances sub-resource in Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The attribute done_by has been added to Promotional credits resource. See : https://apidocs.chargebee.com/docs/api/promotional_credits

New payment method wechat_pay has been added. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The endpoint Manage Payment Sources has been undeprecated in Hosted pages resource. See : https://apidocs.chargebee.com/docs/api/hosted_pages

---

The attribute 'round_off_amount' have been added in Invoice an Credit note resources. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The attribute 'settled_at' has been added to transaction resource. See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes

'Collect now' API in Hosted pages resource has been undeprecated. See : https://apidocs.chargebee.com/docs/api/hosted_pages#collect_now

• New endpoint "Update invoice details" has been added to Invoice resource.

---

** API changes **:

• The new resource Promotional Credits has been added

• The new sub resource balances has been added

• The API end point add_promotional_credits, deduct_promotional_credits and set_promotional_credits has been deprecated in customer resource

** Events added**:

• New Event Type promotional_credits_added and promotional_credits_deducted has been added

---

** API changes**:

• The new resource Coupon Set has been added

• The API end point create a coupon code for a coupon has been deprecated in coupon code resource

• The attribute coupon_set_id has been added to 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

** Attributes added**:

• New attribute remaining_billing_cycles has been added in addons under subscription resource.

** Events added**:

• New event type coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_updated, coupon_codes_deleted

---

** APIs added**:

New endpoint 'Collect payment for a customer' has been added as a restricted and deprecated API.

** APIs updated**:

The attribute 'amount_to_collect' would be added to Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

---

** APIs updated**:

The attribute payment_source_id would be added to the transaction resource. See : https://apidocs.chargebee.com/docs/api/transactions#transaction_payment_source_id

The filter parameter payment_source_id would be added in List transactions API. See : https://apidocs.chargebee.com/docs/api/transactions#list_transactions

The gateway types amazon_payments and paypal_express_checkout would be added. See : https://apidocs.chargebee.com/docs/api/customers#customer_payment_method_gateway

---

** APIs updated**:

The attribute registered_for_gst has been added to the Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The parameter registered_for_gst has been added in Create a customer , Update billing info for a customer , Create subscription estimate , Update subscription estimate , Create a subscription and Update a subscription APIs. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer

---

** APIs added**:

The new endpoint Record refund for a credit note has been added to Credit note resource. See : https://apidocs.chargebee.com/docs/api/credit_notes#record_refund_for_a_credit_note

** APIs updated**:

The parameter tmp_token has been deprecated in card subresource in Create a customer , Create a subscription , Update a subscription and Import subscription APIs. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer

The parameter tmp_token has been added to payment method subresource in Create a subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription

The type apple_pay has been added to payment method types. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer_payment_method_type

---

** APIs added**:

The parameters credit_option_for_current_term_charges, unbilled_charges_option,refundable_credits_handling and account_receivables_handling would be added inCancel subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#cancel_a_subscription

A new endpoint Cancel subscription estimate would be added to the Estimate resource. See : https://apidocs.chargebee.com/docs/api/estimates#cancel_subscription_estimate

The attribute deleted would be added to the Unbilled charge resource. See : https://apidocs.chargebee.com/docs/api/unbilled_charges#unbilled_charge_attributes

The parameter include_deleted would be added in List Unbilled Charges API. See : https://apidocs.chargebee.com/docs/api/unbilled_charges#list_unbilled_charges

---

** APIs added**:

The endpoints Void a credit note and Delete a credit note would be added to the Credit notes resource. See : https://apidocs.chargebee.com/docs/api/credit_notes

The endpoints Apply payments for an invoice, Apply credits for an invoice, Remove payment from an invoice and Remove credit note from an invoice would be added to the Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices

---

** APIs added**:

A new endpoint 'Update a card payment source' would be added to the Payment source resource. See : https://apidocs.chargebee.com/docs/api/payment_sources#update_a_card_payment_source

---

** APIs updated**:

The attribute trial_end has been added to Subscriptions Addon subresource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_addons_trial_end

The parameter trial_end would be added to Addon subresource in Create a subscription,Create subcription for customer, Update a subcription, Create subscription estimate, Create subscription for customer estimate and Update subscription estimate APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription_addons_trial_end

---

** APIs added**:

The new resource 'Time Machine' has been added.

---

** APIs added**:

The new endpoint 'Change Billing Date' has been added to Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#change_billing_date

The new endpoints 'Upcoming invoices estimate' and 'Subscription change term end estimate' have been added to Estimate API. See : https://apidocs.chargebee.com/docs/api/estimates#upcoming_invoices_estimate

** APIs updated**:

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. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The event types 'unbilled_charges_created', 'unbilled_charges_voided', 'unbilled_charges_deleted' and 'unbilled_charges_invoiced' have been added. See : https://apidocs.chargebee.com/docs/api/events#event_types

The parameter 'billing_alignment_mode' has been added to Create a subscription, Create a subscription for customer, Update a customer, Reactivate a subscription, Create subscription estimate, Create subscription for customer estimate, Update a subscription estimate, Checkout new subscription and Checkout existing subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription

The parameters 'line_item_date_from' and 'line_item_date_to' have been added to Add Charge API. See : https://apidocs.chargebee.com/docs/api/invoices#add_charge_item_to_pending_invoice

The parameters 'prorate' and 'invoice_immediately' have been added Change term end API. See : https://apidocs.chargebee.com/docs/api/subscriptions#change_term_end

---

** APIs updated**:

The parameter "status" has been added to the Create a plan, Create an addon and Create a coupon APIs. See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan

The attribute "issuing_country" has been added to the Card and Payment source resource. See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_attributes

The reason code "fraudulent" has been added to the Credit note resource. See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_reason_code

The attribute "bank_name" is made optional in Bank Account subresource. See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_bank_account_bank_name

The parameter "redirect_url" has been made optional in Create a portal session API. See : https://apidocs.chargebee.com/docs/api/portal_sessions#create_a_portal_session

The attributes "fraud_flag" and "fraud_reason" have been added to the Transaction resource. See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes

---

The endpoint Invoice Now Estimate has been added to the Unbilled Charge resource. See : https://apidocs.chargebee.com/docs/api/customers#assign_payment_role

** APIs updated**:

The filter param "phone" has been added to the List Customer API. See : https://apidocs.chargebee.com/docs/api/customers#list_customers

The subresource "invoice_estimates" has been added to the Estimate resource. See : https://apidocs.chargebee.com/docs/api/estimates#invoice_estimate_attributes

---

** APIs added**: The new resources Payment Source has been added. See: https://apidocs.chargebee.com/docs/api/payment_sources

The new resources Unbilled Charge has been added. See : https://apidocs.chargebee.com/docs/api/unbilled_charges

The endpoint Assign payment role has been added to the Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#assign_payment_role

The endpoint Override Billing Profile has been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#override_billing_profile

** APIs updated**: The attribute payment_source_id has been added to the Card resource. See : https://apidocs.chargebee.com/docs/api/cards#card_attributes

The attribute subscription_id has been added to the lineitems subresource in Invoice , Credit Note , Invoice estimate , Next invoice estimate and Credit Note estimate . See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

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. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The attributes payment_source_id and auto_collection have been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The subresource unbilled_charge_estimates has been added to the Estimate resource. See : https://apidocs.chargebee.com/docs/api/estimates#unbilled_charge_estimate_attributes

The param consolidated_invoicing has been added to Create a customer and Update a customer APIs. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer

The input params auto_collection, invoice_immediately and consolidated_invoicing have been added to Create subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription

The input params auto_collection, payment_source_id and invoice_immediately have been added to Create subscription for customer API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_subscription_for_customer

The input params credit_type and reference have been added to Add promotional credits for a customer , Deduct promotional credits for a customer and Set promotional credits for a customer APIs. See : https://apidocs.chargebee.com/docs/api/customers#add_promotional_credits_to_a_customer

The input param invoice_immediately has been added to the Update a subscription , Reactivate subscription , Create subscription estimate , Create subscription for customer estimate and Update subscription estimate APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription

The input param auto_collection has been added to the Subscription subresource and consolidated_invoicing have been added to the Customer subresource in Checkout new subscription API. See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription

The input param payment_source_id has been added to Import a subscription , Create an invoice , Create invoice for charge , Create invoice for addon and Collect payment for an invoice APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription

The event types payment_source_added, payment_source_updated and payment_source_deleted have been added. See : https://apidocs.chargebee.com/docs/api/events#event_types

---

** APIs added**: The endpoints 'List' and 'Acknowledge' APIs have been added to the Hosted page resource. See : https://apidocs.chargebee.com/docs/api/hosted_pages

** APIs updated**: A new subresource 'line_item_discounts' has been added to the Invoice, Credit note, Invoice estimates and Credit note estimates resources. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The Card statuses 'pending_verification' and 'invalid' have been added to the Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The Payment Method types 'generic', 'alipay' and 'unionpay' have been added to the Payment Method type in the Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

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. See : https://apidocs.chargebee.com/docs/api/hosted_pages#hosted_page_attributes

A new gateway 'adyen' has been added. See : https://apidocs.chargebee.com/docs/api/cards#card_attributes

---

** APIs updated**: The input parameter 'id' have been removed in Update a Plan and Update an addon resources. See: https://apidocs.chargebee.com/docs/api/plans#update_a_plan

The input parameter 'terms_to_charge' have been added in Create a subscription,Create subscription for a customer, Create subscription estimate, create subscription for customer estimate, Reactivate a subscription and Checkout new hosted pages APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_subscription_for_customer

The filter input parameter 'next_billing_at' have been added in List Subscriptions API. See : https://apidocs.chargebee.com/docs/api/subscriptions#list_subscriptions

The input parameter 'force_term_reset' have been added to Checkout existing hosted pages API. See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_existing_subscription

A new attribute 'has_advance_charges' have been added to the Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

---

** APIs added**: New resources 'Site Migration Details' and 'Resource Migrations' have been added. See : https://apidocs.chargebee.com/docs/api/site_migration_details

A new endpoint 'Move a customer' has been added. See : https://apidocs.chargebee.com/docs/api/customers#move_a_customer

** APIs updated**: The attributes 'id' and 'for_site_merging' have been added to Copy an addon, Copy a coupon and Copy a plan API. See : https://apidocs.chargebee.com/docs/api/plans#copy_a_plan

The event types 'customer_moved_out' and 'customer_moved_in' have been added. See : https://apidocs.chargebee.com/docs/api/events#event_types

The input parameters 'ignore_scheduled_cancellation' and 'ignore_scheduled_changes' have been added to the Subscription renewal estimate API. See : https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate

---

** APIs updated**: A new reason code 'Subscription cancellation' has been added to the Credit note resource. See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_attributes

A attribute 'has_advance_charges' has been added to the Invoice resource and the input filter parameter 'has_advance_charges' has been added to List Invoice API. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

A new attribute 'next_billing_at' has been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The input parameters 'terms_to_charge', 'reactivate', 'reactivate_from' have been added to Update a Subscription, Update a subscription estimate and Checkout existing hosted page APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription

The input parameter 'reactivate_from' has been added to Reactivate a subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#reactivate_a_subscription

** APIs added**: A new endpoint 'Charge Future Renewals' has been added to the Subscription API. https://apidocs.chargebee.com/docs/api/subscriptions#charge_future_renewals

---

** APIs updated**: 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 from Update card for customer, Switch gateway and Copy card APIs. See: https://apidocs.chargebee.com/docs/api/cards

A 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 customer, Create subscription, Update Subscription and Import subscription API. See: https://apidocs.chargebee.com/docs/api/customers

A input param 'fraud_flag' has been added to Update customer API. See: https://apidocs.chargebee.com/docs/api/customers#update_a_customer

A input param 'gateway' has been deprecated and a new input param 'gateway_account_id' has been added to Payment method sub resource in Update card for a customer API. See: https://apidocs.chargebee.com/docs/api/cards#update_card_for_a_customer

A 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 card and Update Payment method APIs. See: https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription

A new input params 'billing_address' and 'shipping_address' has been added to Checkout new hosted page API. See: https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription

** APIs added**: A new endpoint Create subscription for a customer estimate has been added to the Estimate resource. See: https://apidocs.chargebee.com/docs/api/estimates#create_subscription_for_a_customer_estimate

---

** APIs added**: A new endpoint, Unarchive a plan has been added to the Plan resource. See: https://apidocs.chargebee.com/docs/api/plans#unarchive_a_plan

A new endpoint, Unarchive an addon has been added to the Addon resource. See : https://apidocs.chargebee.com/docs/api/addons#unarchive_an_addon

A new endpoint, Unarchive a coupon has been added to the Coupon resource. See : https://apidocs.chargebee.com/docs/api/coupons#unarchive_a_coupon

---

** APIs updated**:

The attributes 'plan_unit_price', 'setup_fee', 'billing_period', 'billing_period_unit' and 'plan_free_quantity' has been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The input parameters 'plan_unit_price', 'setup_fee' and Addon 'unit_price' has been added to Create a subscription, Create subscription for customer, Update a subscription, Create a subscription estimate, Update a subscription estimate, Checkout a new subscription and Checkout existing subscription, Import a subscription and Import subscription for customer APIs. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription

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. See : https://apidocs.chargebee.com/docs/api/invoices#create_an_invoice

An attribute 'tax_exempt_reason' has been added to line items sub resource in Invoice, Credit Note and Estimate resources. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

---

** APIs updated**: A new attribute, 'locale' has been added to the Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

A new parameter, 'locale' has been to Create a customer, Update a customer, Checkout new hosted page, Create a subscription and Import a subscription APIs. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer

The attributes 'mrr', 'exchange_rate' and 'base_currency_code' have been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

A new filter parameter 'cancelled_at' has been added to List Subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#list_subscriptions

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. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The attributes 'sku', 'accounting_code', 'accounting_category1' and 'accounting_category2' have been added to the Plan and the Addon resource. See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes

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. See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan

The input parameters 'transaction_id_at_gateway', 'transaction_status', 'transaction_error_code' and 'transaction_error_text' have been added to Record payment for an invoice API. See : https://apidocs.chargebee.com/docs/api/invoices#record_an_invoice_payment

---

** APIs updated**: A new attribute, 'funding_type' has been added to Card resource. See : https://apidocs.chargebee.com/docs/api/cards#card_attributes

** APIs added**: A new endpoint, List coupon codes API has been added to Coupon Code resource. See : https://apidocs.chargebee.com/docs/api/coupon_codes#list_coupon_codes

A new endpoint, Copy a plan API has been added to Plan resource. See : https://apidocs.chargebee.com/docs/api/plans#copy_a_plan

A new endpoint, Copy an addon API has been added to Addon resource. See : https://apidocs.chargebee.com/docs/api/addons#copy_an_addon

A new endpoint, Copy a coupon API has been added to Coupon resource. See : https://apidocs.chargebee.com/docs/api/coupons#copy_a_coupon

A new endpoint, Import a subscription API has been added to Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription

A new endpoint, Import Subscription for customer API has been added to Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#import_subscription_for_customer

A new endpoint, Import invoice API has been added to Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#import_invoice

---

** APIs updated**: A new attribute, 'tax_profile_id' has been added to Addon and Plan resource. See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes

The new input parameter 'tax_profile_id' has been added in Create and Update Addon and Plan APIs. See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan

The new cancel reason type 'non_compliant_customer' has been added to the Subscription resource. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

---

** APIs updated**: The attributes "updated_at" and "resource_version" is added to Plan, Addon and Coupon resource. See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes

Following Event types are added

• 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" is added. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The attribute "net_term_days" is added to Customer resource and new input parameter "net_term_days" is added to Create Customer and Update Customer API. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The input parameter "net_term_days" is added to Create a Subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription

The attributes "net_term_days" and "due_date" is added to the Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices

---

** APIs updated**:

The attribute "preferred_currency_code" is added to Customer and a new input parameter "preferred_currency_code" is added Create Customer and Update Customer API. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

---

** APIs updated**: The new attributes "updated_at", "resource_version" and "deleted" is returned as part of Customer, Subscription, Invoice, Credit Note and Transaction resources. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The new parameter "include_deleted" is added to Customer, Subscription, Invoice, Credit Note and Transaction List API. See : https://apidocs.chargebee.com/docs/api/customers#list_customers

The new parameter "date" is added to Create Credit Note API. See : https://apidocs.chargebee.com/docs/api/credit_notes#create_credit_note

---

** APIs added**: A new endpoint to create Credit Note is added. See : https://apidocs.chargebee.com/docs/api/credit_notes#create_credit_note

A new endpoint to write off Invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#write_off_an_invoice

** APIs updated**: The attribute "forward_url" is given as input for Create a Portal Session API. See : https://apidocs.chargebee.com/docs/api/portal_sessions#create_a_portal_session

---

** APIs updated**: The attribute "validation_status" is added to address. See : https://apidocs.chargebee.com/docs/api/addresses#address_attributes

The attribute "validation_status" is added to Customer billing address and the attribute "fraud_flag" is now returned Customer in case of any fraudulent transactions. The API's Create Customer, Update Billing Info for a Customer now take in "validation_status" for address objects. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The attribute "validation_status" is added to Subscription shipping address. The API's Create Subscription, Create Subscription for Customer, Update Subscription now take in "validation_status" for address objects. See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes

The attribute "validation_status" is returned as part of Invoice billing and shipping address. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes

The sub resource "shipping_address" is now returned as part of Subscription Estimate in Estimate APIs. See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes

The attribute "created_from_ip", "card_ip_address" is deprecated from Customer and Subscription resource. See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes

The attribute "tmp_token" is added to Payment Method subresource that can be used in Create and Update Payment Method for a Customer API for direct_debit type through Stripe gateway. See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer

The status "pending_verification" added to Payment Method status. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes

---

** APIs added**: A new endpoint to retrieve Credit Note as PDF. See : https://apidocs.chargebee.com/docs/api/credit_notes#retrieve_credit_note_as_pdf

** APIs updated**: The attribute "invoice notes" is added to subscription in Hosted Pages Checkout New and Checkout Existing API's. See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription

The filter parameter "paid_at" is added to list invoices and "paid_on_after" is deprecated. See : https://apidocs.chargebee.com/docs/api/invoices#list_invoices

The filter parameter "occurred_at", "webhook_status", "event_type" is added to list events and parameter "start_time", "end_time", "webhook_status", "event_type" is deprecated. See : https://apidocs.chargebee.com/docs/api/events#list_events

---

** APIs added**: A new endpoint to remove coupons associated with the subscription is added. See : https://apidocs.chargebee.com/docs/api/subscriptions#remove_coupons A new endpoint to record excess payments for a customer is added. See : https://apidocs.chargebee.com/docs/api/customers#record_an_excess_payment_for_a_customer