Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
chargebee-typescript
Advanced tools
chargebee-typescript - npm Package Versions
Changelog
v2.8.0 (2022-04-25)
Fixes:
- Fixed return type of Subscription#contract_terms_for_subscription, Customer#contacts_for_customer, ItemPrice#find_applicable_items and ItemPrice#find_applicable_item_prices.
New endpoints:
- UnbilledCharge#CreateUnbilledCharge has been added to UnbilledCharge resource. Applicable only for PC1.0.
New attributes:
- channel have been added to the Addon, AttachedItem, CreditNote, Customer, Invoice, ItemFamily, ItemPrice, Plan and Subscription resources.
- external_name and channel have been added to the Item resource.
New input parameters:
- external_name have been added to Item#CreateRequest and Item#UpdateRequest.
- channel have been added to Addon#AddonListRequest.
- channel have been added to CreditNote#CreditNoteListRequest.
- channel have been added to Customer#CustomerListRequest.
- invoice[channel], subscription[channel] and customer[channel] have been added to Export#RevenueRecognitionRequest and Export#DeferredRevenueRequest.
- plan[channel] have been added to Export#PlansRequest.
- addon[channel] have been added to Export#AddonsRequest.
- customer[channel] have been added to Export#CustomersRequest.
- subscription[channel] have been added to Export#SubscriptionsRequest.
- invoice[channel] have been added to Export#InvoicesRequest.
- credit_note[channel] have been added to Export#CreditNotesRequest.
- item[channel] have been added to Export#ItemsRequest.
- item_price[channel] have been added to Export#ItemPricesRequest.
- channel have been added to Invoice#InvoiceListRequest.
- channel have been added to Item#ItemListRequest.
- channel have been added to ItemPrice#ItemPriceListRequest.
- channel have been added to Plan#PlanListRequest.
- channel have been added to Subscription#SubscriptionListRequest.
Existing input parameter changes:
- item_family_id in Item#CreateRequest has been made as required field.
Removed enum values:
- coupon_expired has been removed from EventTypeEnum.
Changelog
v2.7.0 (2022-03-14)
New Input parameters:
- net_term_days has been added to subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items, subscriptions#import_subscription_for_items endpoints.
Changelog
v2.6.0 (2022-03-08)
Fixes:
- Fixed serialization issue for nested array attributes
New attributes:
- upi, mandates and their subresources have been added to the payment_source resource.
New Input parameters:
- bank_account[phone] have been added to customers#create_bank_account
- payment_intent[payment_method_type] have been added to customers#create_payment_intent, customers#collect_payment_intent
- payment_intent[payment_method_type] have been added to estimate#gift_subscription and estimate#gift_subscription_for_items.
- payment_intent[payment_method_type] have been added to gift#create_payment_intent and gift#create_gift_for_items_payment_intent.
- customer[is_einvoice_enabled], customer[entity_identifier_scheme], customer[entity_identifier_standard], entity_identifiers[id], entity_identifiers[scheme], entity_identifiers[value], entity_identifiers[operation], entity_identifiers[standard] have been added to hosted_page#checkout_onetime_for_items, hosted_page#checkout_new_for_items and hosted_page#checkout_existing_for_items.
- bank_account[phone] have been added to invoice#create_bank_account, invoice#create_bank_account_for_chargeitems_and_charges
- payment_intent[payment_method_type] have been added to invoice#create_payment_intent, invoice#create_payment_intent_for_chargeitems_and_charges
- bank_account[phone] have been added to payment_source#create_bank_account
- payment_intent[payment_method_type] have been added to payment_source#create_using_payment_intent
- subscription_id have been added to payment_source#list_payment_source
- bank_account[phone] have been added to subscription#create_bank_account
- payment_intent[payment_method_type] have been added to subscription#create_payment_intent, subscription#create_payment_intent_for_customer, subscription#create_payment_intent_with_items, subscription#update_payment_intent, subscription#update_payment_intent_for_items, subscription#reactivate_payment_intent, subscription#resume_payment_intent
- activated_at have been added to subscription#import_subscription, subscription#import_subscription_for_customer, subscription#import_subscription_for_items
New Enum values:
- upi, netbanking_emandates enum has been added in customer_payment_method_type subresource of customer resource
- current enum has been added in account_type.
- quickbooks, razorpay enum has been added in gateway.
- upi, netbanking_emandates enum has been added in payment_method,payment_method_type, type
- upi, netbanking_emandates, apple_pay enum has been added in payment_method_type subresource of payment_intent resource
- current enum has been added in bank_account_type subresource of payment_source.
Deprecated attributes:
- coupon attribute have been added and deprecated in hosted_page resource.
Deprecated enums:
- NetdPaymentDueReminder have been deprecated in event_type.
Changelog
v2.5.0 (2022-01-21)
Fixes:
- Added return types to all requests.
- Updated readme to include lazy loading process and removed trailing spaces.
New endpoints:
- credit_notes#download_einvoice has been added to the credit_notes resource.
- invoice#download_einvoice has been added to the invoice resource.
New attributes:
- is_einvoice_enabled, entity_identifier_scheme, entity_identifier_standard and entity_identifiers[] have been added to the customer resource.
- einvoice has been added to the invoice resource.
- einvoice has been added to the credit_notes resource.
- mime_type has been added to the download resource.
New Input parameters:
- entity_identifier_scheme, entity_identifier_standard, is_einvoice_enabled, entity_identifiers[id][0..N], entity_identifiers[scheme][0..N], entity_identifiers[value][0..N], entity_identifiers[standard][0..N] have been added to customers#create_a_customer, customers#update_billing_info_for_a_customer apis.
- customer[entity_identifier_scheme], customer[entity_identifier_standard], customer[is_einvoice_enabled], entity_identifiers[id][0..N], entity_identifiers[scheme][0..N], entity_identifiers[value][0..N], entity_identifiers[standard][0..N] have been added to the subscriptions#create_a_subscription api.
- customer[entity_identifier_scheme], customer[entity_identifier_standard], customer[is_einvoice_enabled] have been added to subscriptions#update_a_subscription and subscriptions#update_subscription_for_items apis.
New Enum values:
- operation enum has been added.
- status enum has been added in credit_notes_einvoice subresource of credit_notes resource.
Deprecated attributes:
- user, type, payment_method and exchange_rate have been deprecated from TaxWithHeld resource.
Deprecated enums:
- type and payment_method have been deprecated in TaxWithHeld resource.
Updated parameters:
- hierarchy_operation_type has been made mandatory in customers#get_hierarchy api.
Removed Filter parameters:
- create_pending_invoices has been removed from subscriptions#list_subscriptions api.
Changelog
v2.4.0 (2021-12-08)
Fixes:
- Added return types to all api requests.
- Fixed validation logic for IDparam.
- Included typescript related packages to devDependencies.
- Exposed function chargebee#updateRequestTimeoutInMillis to set custom time out.
- Updated default request timeout to 80000ms.
New endpoints:
- payment_sources#update_bank_account have been added in payment_sources resource.
- item_price#item_price_find_applicable_items and item_price#item_price_find_applicable_item_prices have been added in item_price resource.
New Attributes:
- hsn_code have been added to the resource addon, item_price and plan.
- first_name, last_name and email have been added to the resource payment_sources.
New Resource:
- TaxWithheld has been added.Applicable only for API V2.
New Input parameters:
- hsn_code have been added to addons#create_an_addon, addons#update_an_addon, plan#create_an_plan and plan#update_an_plan apis.
- bank_account[first_name],bank_account[last_name] and bank_account[email] have been added to payment_sources#update_bank_account api.
- charges[hsn_code] have been added in estimate#Create_Invoice, estimate#Create_Invoice_For_Items, hosted_pages#Checkout_One_Time, hosted_pages#Checkout_One_Time_For_Items, invoice#create_an_invoice, invoice#Create_For_Charge_Items_And_Charges and unbilledCharge#create_an_unbilledCharge apis.
- tax_detail[hsn_code] have been added in item_price#create_an_itemPrice and item_price#update_an_itemPrice apis.
- include_deleted have been added in plan#plan_list and addon#addon_list apis.Applicable only for Product Catalog V1.
New Enum values:
- subscription_activated_with_backdating, tax_withheld_recorded, tax_withheld_deleted and tax_withheld_refunded has been added to event_type enum.
Changelog
v2.3.0 (2021-10-14)
New Attributes:
- entity_id has been added in order_line_item_discounts resource.
New Input parameters:
- line_items[tax5_name], line_items[tax5_amount], line_items[tax6_name], line_items[tax6_amount], line_items[tax7_name], line_items[tax7_amount], line_items[tax8_name], line_items[tax8_amount], line_items[tax9_name], line_items[tax9_amount], line_items[tax10_name], line_items[tax10_amount] have been added in import_invoice api.
- replace_primary_payment_source has been added in create_subscription_for_customer and create_subscription_for_items apis.
New Enum values:
- coupon_expired has been added to event_type enum.
- mollie has been added to gateway enum.
- item_level_discount and document_level_discount has been added to discount_type.
Changelog
v2.2.0 (2021-08-16)
- moved types to dev dependencies.
- made default callback value to undefined to make it optional.
New Attributes:
- generated_at has been added in credit_note and invoice resources.
- change_option have been added in quoted_subscription resource.
- changes_scheduled_at has been added in subscription and quoted_subscription resources.
- iin and last4 have been added in transaction resource.
New Resource:
- quoted_charge has been added.
New Input parameters:
- invoice_date has been added in estimates##create_subscription_estimate, estimates#estimate_for_creating_a_customer_and_subscription, estimates#estimate_for_creating_a_subscription, estimates#create_subscription_for_a_customer_estimate, estimates#update_subscription_estimate, estimates#estimate_for_updating_a_subscription, estimates#cancel_subscription_estimate, estimates#cancel_subscription_for_items_estimate, estimates#create_invoice_for_items_estimate, estimates#create_invoice_estimate, hosted_pages#checkout_existing_subscription, hosted_pages#create_checkout_to_update_a_subscription, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, subscriptions#create_a_subscription, subscriptions#create_subscription_for_customer, subscriptions#update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items, subscriptions#reactivate_a_subscription, subscriptions#cancel_subscription_for_items and subscriptions#cancel_a_subscription endpoints.
- coupon_ids has been added to invoices#create_invoice_for_a_one-time_charge, invoice#create_invoice_for_a_non-recurring_addon, quotes#create_quote_for_one-time_charges, quotes#edit_quote_for_one-time_charges, quotes#create_a_quote_for_charge_and_charge_items, quotes#edit_quote_for_charge_items_and_charges endpoints.
- change_option and changes_scheduled_at have been added in quotes#create_quote_for_updating_a_subscription, quotes#edit_quote_for_updating_a_subscription, quotes#create_a_quote_for_update_subscription_items, quotes#edit_update_subscription_quote_for_items, subscriptions#update_a_subscription and subscriptions#create_subscription_for_items endpoints.
- invoice_date, create_pending_invoices and first_invoice_pending have been added in quotes#convert_a_quote endpoint.
- subscription[auto_close_invoices] has been added in quotes#convert_a_quote endpoint.
New Enum values:
- subscription_cancel has been added to charge_event enum in quote_line_groups resource.
- subscription_created_with_backdating, subscription_changed_with_backdating, subscription_canceled_with_backdating, subscription_reactivated_with_backdating, invoice_generated_with_backdating and credit_note_created_with_backdating have been added to event_type enum
- change_option enum has been added.
Deprecated parameters:
- coupon has been deprecated in invoices#create_invoice_for_a_one-time_charge and invoices#create_invoice_for_a_non-recurring_addon endpoints.
Changelog
v2.1.0 (2021-07-22)
Fixes:
- Changed use of deprecated Buffer allocation from
new Buffer()toBuffer.from().
New endpoints:
- hosted_pages#checkout_one_time_for_items and hosted_pages#checkout_gift_for_items have been added in hosted_pages resource.
- orders#resend_an_order has been added in orders resource.
- quotes#edit_create_subscription_quote_for_items, quotes#edit_update_subscription_quote_for_items and quotes#edit_quote_for_charge_items_and_charges have been added in quotes resource. Applicable only for Product Catalog V2.
New attributes:
- accounting_category3 and accounting_category4 have been added to addon, item_price and plan resources.
- quantity_in_decimal has been added to attached_item resource.
- period and period_unit have been added to coupon resource.
- entity_id has been added to line_item_discounts object of credit_note, credit_note_estimate, invoice, invoice_estimate, quote and quote_line_group resources.
- vat_number_prefix has been added to credit_note, customer, invoice and quote resources.
- price_in_decimal has been added to differential_price and item_price resources.
- exchange_rate and new_sales_amount have been added to invoice resource.
- archived_at has been added to item and item_price resources.
- trial_end_action has been added to item_price, plan, subscription and subscription_estimate resources.
- resent_orders, tracking_url, resent_status, is_resent, original_order_id and resend_reasons have been added to order resource.
- line_item_tiers have been added to quote resource.
- plan_quantity_in_decimal and plan_unit_price_in_decimal have been added to quoted_subscription and subscription resources. Applicable only for Product Catalog V1.
- contract_term_billing_cycle_on_renewal and quoted_contract_term have been added to quoted_subscription resource.
- quantity_in_decimal, metered_quantity, last_calculated_at, unit_price_in_decimal, amount_in_decimal and free_quantity_in_decimal have been added to subscription_items object of quoted_subscription and subscription resources.
- starting_unit_in_decimal, ending_unit_in_decimal and price_in_decimal have been added to item_tiers object in quoted_subscription resources.
- cancel_schedule_created_at has been added to subscription resource.
- exchange_rate and merchant_reference_id have been added to transaction resource.
New parameters:
- accounting_category3 and accounting_category4 have been added in addons#create_an_addon, addons#update_an_addon, plans#create_a_plan and plans#update_a_plan endpoints.
- quantity_in_decimal has been added in attached_items#create_an_attached_item, attached_items#update_an_attached_item and gifts#create_a_gift_subscription_for_items endpoints.
- period and period_unit have been added in coupons#create_a_coupon, coupons#update_a_coupon, coupons#create_a_coupon_for_items and coupons#update_a_coupon_for_items endpoints.
- vat_number_prefix has been added in customers#create_a_customer, customers#update_billing_info_for_a_customer, estimates#create_subscription, estimates#create_subscription_estimate, estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, hosted_pages#checkout_new_subscription, hosted_pages#checkout_one-time_payments, hosted_pages#create_checkout_for_a_new_subscription hosted_pages#checkout_existing_subscription, hosted_pages#create_checkout_to_update_a_subscription, invoices#import_invoice, invoices#update_invoice_details, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
- payment_method[additional_information] has been added in customers#create_a_customer, customers#update_payment_method_for_a_customer, customers#collect_payment_for_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
- card[additional_information] has been added in customers#create_a_customer, customers#collect_payment_for_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, payment_sources#create_a_card_payment_source, subscriptions#create_a_subscription, subscriptions#update_a_subscription, subscriptions#update_subscription_for_items and subscriptions#import_a_subscription endpoints.
- bank_account[billing_address] has been added in customers#create_a_customer, invoices#create_an_invoice, invoices#create_invoice_for_items_and_one-time_charges, payment_sources#create_a_bank_account_payment_source and subscriptions#create_a_subscription endpoints.
- price_in_decimal has been added in differential_prices#create_a_differential_price and differential_prices#update_a_differential_price endpoints.
- tiers[starting_unit_in_decimal][0..N], tiers[ending_unit_in_decimal][0..N] and tiers[price_in_decimal][0..N] have been added in differential_prices#create_a_differential_price, differential_prices#update_a_differential_price, item_prices#create_an_item_price and item_prices#update_an_item_price endpoints.
- remove_general_note and notes_to_remove been added in estimates#create_invoice_estimate, estimates#create_invoice_for_items_estimate and invoices#create_invoice_for_items_and_one-time_charges endpoints.
- trial_end_action has been added in estimates#create_subscription, estimates#create_subscription_estimate, estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, plans#create_a_plan, plans#update_a_plan, item_prices#create_an_item_price, item_prices#update_an_item_price, subscriptions#create_a_subscription, subscriptions#create_subscription_for_customer, subscriptions#create_subscription_for_items, subscriptions#update_a_subscription and subscriptions#update_subscription_for_items endpoints.
- subscription_items[unit_price_in_decimal][0..N], item_tiers[starting_unit][0..N], item_tiers[ending_unit][0..N] and item_tiers[price_in_decimal][0..N] have been added in estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, estimates#cancel_subscription_for_items_estimate, hosted_pages#create_checkout_for_a_new_subscription, hosted_pages#create_checkout_to_update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items and subscriptions#import_subscription_for_items endpoints.
- subscription_items[quantity_in_decimal][0..N] has been added in estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#cancel_subscription_for_items_estimate, estimates#update_subscription_for_items, estimates#update_subscription, estimates#gift_subscription_for_items, estimates#cancel_subscription_for_items_estimate, gifts#create_a_gift_subscription_for_items, hosted_pages#create_checkout_for_a_new_subscription, hosted_pages#create_checkout_to_update_a_subscription, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items, subscriptions#import_subscription_for_items and subscriptions#cancel_subscription_for_items endpoints.
- notes_to_remove[entity_type][0..N] and notes_to_remove[entity_id][0..N] have been added in estimates#create_invoice, estimates#create_invoice_for_items and invoices#create_invoice_for_items_and_one-time_charges endpoints.
- item_prices[quantity_in_decimal][0..N] and item_prices[unit_price_in_decimal][0..N] have been added in estimates#create_invoice_for_items, invoices#create_invoice_for_items_and_one-time_charges and unbilled_charges#create_unbilled_charges_for_a_subscription endpoints.
- item_tiers[starting_unit_in_decimal][0..N], item_tiers[ending_unit_in_decimal][0..N] and item_tiers[price_in_decimal][0..N] have been added in estimates#create_invoice_for_items, invoices#create_invoice_for_items_and_one-time_charges and unbilled_charges#create_unbilled_charges_for_a_subscription endpoints.
- payment_intent[additional_information] has been added in customers#create_a_customer, customers#collect_payment_for_customer, gifts#create_a_gift_subscription_for_items, gifts#create_a_gif and payment_sources#create_using_payment_intent endpoints.
- invoice_note has been added in hosted_pages#checkout_one-time_payments endpoint.
- allow_offline_payment_methods has been added in hosted_pages#create_checkout_for_a_new_subscription and hosted_pages#create_checkout_to_update_a_subscription endpoints.
- free_quantity_in_decimal, price_in_decimal and trial_end_action have been added in item_prices#create_an_item_price and item_prices#update_an_item_price endpoints.
- tracking_url has been added in orders#create_an_order, orders#update_an_order and orders#import_an_order endpoints.
- additional_information has been added in payment_sources#create_using_gateway_temporary_token and payment_sources#create_using_permanent_token endpoints.
New enum values:
- bancontact has been added to card_type enum.
- card and latam_local_card have been added to powered_by enum.
- item_level_discount and document_level_discount have been added to entity_type enum of credit_note_discount, credit_note_estimate_discount, invoice_discount, line_item_discount and invoice_estimate_discount resources.
- item_level_discount and document_level_discount have been added to discount_type enum.
- add_usages_reminder and order_resent have been added to event_type enum.
- ingenico_direct and exact have been added to gateway enum.
- max_usage has been added to usage_calculation enum.
- trial_end_action enum has been added.
- order_resent has been added to cancellation_reason enum.
- resent_status enum has been added.
- custom_discount has been added in discount_type enum of order_line_item_discount.
New filter parameters:
- resent_status, is_resent and original_order_id filter parameters have been added in exports#orders and orders#list_orders enpoints.
- updated_at filter parameter has been added in exports#item_families and item_families#list_item_families endpoints.
New sort parameters:
- name, id and updated_at sort parameters are added to items#list_items and item_prices#list_item_prices endpoints.
- created_at and updated_at sort parameters are added to payment_sources#list_payment_sources endpoint.
- usage_date sort parameter has been added to usages#list_usages endpoint.
Deprecated parameters:
- duration_month parameter has been deprecated in coupon resource.