New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
chargebee
Advanced tools
chargebee - npm Package Compare versions
Comparing version 1.3.4 to 2.0.0
176
CHANGELOG.md
@@ -0,1 +1,31 @@ | ||
| ### v2.0.0 (2016-04-11) | ||
| * * * | ||
| #### Attributes and Operations Removed/Renamed in V2 | ||
| Chargebee [API V2](https://apidocs.chargebee.com/docs/api#versions) is now live! All our future developments will happen in V2. | ||
| V2 has been released to accommodate certain backwards-incompatible changes. Refer our [API V2 Upgradation guide](https://apidocs.chargebee.com/docs/api#api-v2-upgradation-guide) for the complete listing of the attributes and operations that have been removed/renamed in API V2. | ||
| #### Incremental Changes in V2 | ||
| * *api_version* attribute is added to [Event](https://apidocs.chargebee.com/docs/api/events) resource. More details [here](#v1176-2016-04-06). | ||
| * Credit Notes resource is introduced. More details here: https://apidocs.chargebee.com/docs/api/credit_notes | ||
| * Operations [Update Subscription](https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription) and [Update Subscription Estimate](https://apidocs.chargebee.com/docs/api/estimates#update_subscription_estimate) additionally returns list of Credit Notes now (if applicable). | ||
| * Operations [Refund an Invoice](https://apidocs.chargebee.com/docs/api/invoices#refund_an_invoice) and [Record Refund for an Invoice](https://apidocs.chargebee.com/docs/api/invoices#record_refund_for_an_invoice) additionally returns a Credit Note if the operation succeeds. Besides, following *input params* are added to these operations - *credit_note[reason_code]* and *customer_notes*. | ||
| * Following attributes are added to [invoice](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) resource | ||
| * *write_off_amount* | ||
| * *applied_credits[]* - the Refundable Credits applied to this invoice. | ||
| * *adjustment_credit_notes[]* - The Adjustment Credit Notes created for this invoice. | ||
| * *issued_credit_notes[]* - The Refundable Credit Notes created against this invoice. | ||
| * For 'Refund' type [transaction](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes), *linked_credit_notes[]* will be returned. | ||
| * Following [Event types](https://apidocs.chargebee.com/docs/api/events#event_types) are added | ||
| * *credit_note_created* | ||
| * *credit_note_updated* | ||
| * *credit_note_deleted* | ||
| * Following attributes are added to [line_items[]](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) sub-resource: | ||
| * *discount_amount* - the total discount amount (both item-level and document-level discounts) of this line. | ||
| * *item_level_discount_amount* - only the item-level-discount amount component. | ||
| * Further [discounts[].entity_type](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) will have two types for coupon - *item_level_coupon* and *document_level_coupon*. | ||
| * Input Param *use_existing_balances* is added to the operations - [Update Subscription Estimate](https://apidocs.chargebee.com/docs/api/estimates#update_subscription_estimate) and [Subscription Renewal Estimate](https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate) | ||
| ### v1.3.4 (2016-04-06) | ||
@@ -7,3 +37,3 @@ * * * | ||
| Chargebee supports multiple [API versions](https://apidocs.chargebee.com/docs/api#versions) now. The *api_version* attribute indicates the API version based on which the event content is structured. More details here: | ||
| https://apidocs.chargebee.com/docs/api/v1/events | ||
| https://apidocs.chargebee.com/docs/api/events | ||
@@ -16,5 +46,5 @@ ### v1.3.3 (2016-03-22) | ||
| Support to specify additional information as "meta_data" in json format for Customer, Subscription, Plan, Addon & Coupon resources. | ||
| Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer | ||
| Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer | ||
| New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
@@ -24,3 +54,3 @@ | ||
| Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/v1/cards#switch_gateway | ||
| Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/cards#switch_gateway | ||
@@ -30,3 +60,3 @@ | ||
| Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/v1/invoices | ||
| Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/invoices | ||
@@ -40,7 +70,7 @@ ### v1.3.2 (2016-02-25) | ||
| New api endpoint to delete 'Subscription' is added to Subscription resources. See delete subscription API here: | ||
| https://apidocs.chargebee.com/docs/api/v1/subscriptions#delete_a_subscription | ||
| https://apidocs.chargebee.com/docs/api/subscriptions#delete_a_subscription | ||
| Support to delete a customer. See: https://www.chargebee.com/docs/customers.html#deleting-a-customer | ||
| New api endpoint to delete 'Customer' is added to Customer resources. See delete customer API here: | ||
| https://apidocs.chargebee.com/docs/api/v1/customers#delete_a_customer | ||
| https://apidocs.chargebee.com/docs/api/customers#delete_a_customer | ||
@@ -50,3 +80,3 @@ | ||
| Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types. | ||
| Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types. | ||
@@ -63,18 +93,18 @@ ** Added**: | ||
| Support to add additional contact for a customer. See: https://www.chargebee.com/docs/customers.html#add-contact | ||
| New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/v1/customers#add_contacts_to_a_customer | ||
| New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/customers#add_contacts_to_a_customer | ||
| ** APIs updated**: | ||
| New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
| Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice | ||
| Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice | ||
| New attribute 'refundable_credits' is returned as part of Customer resource. | ||
| New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
| New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes | ||
| New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes | ||
| New entity type 'credit_note' is added as part of 'entity_type' attribute of Comment resource. | ||
| See: https://apidocs.chargebee.com/docs/api/v1/comments#comment_attributes | ||
| See: https://apidocs.chargebee.com/docs/api/comments#comment_attributes | ||
@@ -96,9 +126,9 @@ ### v1.3.0 (2015-12-15) | ||
| New attribute "excess_payments" is returned as part of Customer resource. | ||
| See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
| New attribute "applied_at" is returned as part of Linked Transaction subresource of Invoice resource. | ||
| See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
| New transaction type "PAYMENT_REVERSAL" is returned as part of Transaction resource. | ||
| See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes | ||
| See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes | ||
@@ -108,3 +138,3 @@ New attributes "amount_unused", "reference_transaction_id", "reversal_transaction_id" & "linked_refunds" subresource are returned as part of Transaction resource. | ||
| New attribute "applied_at" is returmed as part of Linked Invoice subresource of Transaction resource. | ||
| See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes | ||
| See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes | ||
@@ -116,14 +146,14 @@ ### v1.2.8 (2015-09-18) | ||
| Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer | ||
| Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer | ||
| Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/v1/plans#create_a_plan | ||
| Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan | ||
| The attribute "taxablility" is returned as part of Customer resource. | ||
| https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
| The attribute "taxable" is returned as part of Plan resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes | ||
| The attribute "taxable" is returned as part of Addon resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/addons#addon_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/addons#addon_attributes | ||
@@ -133,3 +163,3 @@ | ||
| See attribute of line_items in Estimate here : | ||
| https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes | ||
| https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes | ||
@@ -142,6 +172,6 @@ ### v1.2.7 (2015-09-07) | ||
| The attribute for "user" is returned as part of Event resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
| Support for multiple webhooks. The attribute "webhooks" contains list of Webhook subresource is returned as part of Event API. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
@@ -158,9 +188,9 @@ ** APIs deprecated**: | ||
| The attribute for "first_invoice" & "currency_code" is returned as part of Invoice resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
| The attribute for "currency_code" is returned as part of Transaction resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes | ||
| A new source type "bulk_operation" is returned as part of "source" attribute of event resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
@@ -172,3 +202,3 @@ ### v1.2.5 (2015-07-20) | ||
| New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#stop_dunning_for_invoice | ||
| New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/invoices#stop_dunning_for_invoice | ||
@@ -178,3 +208,3 @@ ** APIs updated**: | ||
| The attribute for "dunning_status" is returned as part of Invoice resource. | ||
| See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
@@ -186,11 +216,11 @@ ### v1.2.4 (2015-07-09) | ||
| New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#record_refund_for_an_invoice | ||
| New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#record_refund_for_an_invoice | ||
| ** APIs updated**: | ||
| Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer | ||
| Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer | ||
| The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
| A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
@@ -208,11 +238,11 @@ A new discount type "account_credits" is added as part of "type" attribute of discounts sub-resource for estimate resource. | ||
| New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#void_an_invoice | ||
| New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#void_an_invoice | ||
| ** APIs updated**: | ||
| A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
| ** APIs deprecated**: | ||
| Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/v1/hosted_pages#update_payment_method | ||
| Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method | ||
@@ -224,15 +254,15 @@ ### v1.2.2 (2015-06-12) | ||
| New api endpoints to Add, Deduct & Set the account credit for a customer is added. See the APIs below - https://apidocs.chargebee.com/docs/api/v1/customers#add_account_credits_to_a_customer | ||
| https://apidocs.chargebee.com/docs/api/v1/customers#deduct_account_credits_for_a_customer | ||
| https://apidocs.chargebee.com/docs/api/v1/customers#set_account_credits_for_a_customer | ||
| New api endpoints to Add, Deduct & Set the account credit for a customer is added. See the APIs below - https://apidocs.chargebee.com/docs/api/customers#add_account_credits_to_a_customer | ||
| https://apidocs.chargebee.com/docs/api/customers#deduct_account_credits_for_a_customer | ||
| https://apidocs.chargebee.com/docs/api/customers#set_account_credits_for_a_customer | ||
| ** APIs updated**: | ||
| Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types. | ||
| Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types. | ||
| A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
| The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes | ||
| The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes | ||
| A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes | ||
| A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes | ||
@@ -252,5 +282,5 @@ ** APIs deprecated**: | ||
| A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer. | ||
| A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer. | ||
| A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice. | ||
| A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice. | ||
@@ -274,3 +304,3 @@ ** APIs updated**: | ||
| A new sub-resource "notes" is returned as part of the Invoice resource attributes. | ||
| See https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes | ||
| See https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes | ||
@@ -280,6 +310,6 @@ A new attribute "amount_due" is returned as part of Invoice resource. | ||
| Checkout new, checkout existing, update payment method method APIs now accept "redirect_url" & "cancel_url" to which your customer should be redirected. | ||
| See https://apidocs.chargebee.com/docs/api/v1/hosted_pages#checkout_new_subscription | ||
| See https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription | ||
| Now, event "subscription_renewal_reminder" can be fetched via API. | ||
| See https://apidocs.chargebee.com/docs/api/v1/events#event_types. | ||
| See https://apidocs.chargebee.com/docs/api/events#event_types. | ||
@@ -292,3 +322,3 @@ ### v1.1.9 (2015-03-30) | ||
| A new API "Delete an Invoice" added to delete un-paid invoices. This feature was supported through admin console earlier, now it is available via API too. | ||
| See https://apidocs.chargebee.com/docs/api/v1/invoices#delete_an_invoice. | ||
| See https://apidocs.chargebee.com/docs/api/invoices#delete_an_invoice. | ||
@@ -300,3 +330,3 @@ ** APIs updated**: | ||
| Now, event "invoice_deleted" can be fetched via API. | ||
| See https://apidocs.chargebee.com/docs/api/v1/events#event_types. | ||
| See https://apidocs.chargebee.com/docs/api/events#event_types. | ||
@@ -308,5 +338,5 @@ ### v1.1.8 (2015-02-27) | ||
| A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#create_an_invoice. | ||
| A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/invoices#create_an_invoice. | ||
| A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/v1/portal_sessions. | ||
| A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/portal_sessions. | ||
@@ -350,6 +380,6 @@ ** APIs updated**: | ||
| A new resource called Order is introduced. This can be used for integrating ChargeBee with any shipping/order management application (like ShipStation). Orders are not automatically generated or updated by ChargeBee currently. They have to be created/updated either via api or merchant web console (a.k.a admin console). An order can be created against an invoice irrespective of the status of the invoice and an invoice can have multiple orders associated with it. | ||
| See https://apidocs.chargebee.com/docs/api/v1/orders?lang=node for details. | ||
| See https://apidocs.chargebee.com/docs/api/orders?lang=node for details. | ||
| **API Updates**: | ||
| Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=node#list_invoices. | ||
| Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/invoices?lang=node#list_invoices. | ||
@@ -388,4 +418,4 @@ ### v1.1.4 (2014-09-16) | ||
| APIs added: | ||
| * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#retrieve_with_scheduled_changes. | ||
| * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#remove_scheduled_changes. | ||
| * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/subscriptions#retrieve_with_scheduled_changes. | ||
| * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/subscriptions#remove_scheduled_changes. | ||
@@ -401,8 +431,8 @@ APIs updated: | ||
| APIs added: | ||
| * Add a one time charged to the subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#add_charge_at_term_end. | ||
| * Add a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#charge_addon_at_term_end. | ||
| *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/v1/estimates#subscription_renewal_estimate | ||
| * Add a one time charged to the subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/subscriptions#add_charge_at_term_end. | ||
| * Add a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/subscriptions#charge_addon_at_term_end. | ||
| *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate | ||
| APIs updated: | ||
| * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes | ||
| * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/plans#plan_attributes | ||
| * Include delayed charges while calculating the Estimate. | ||
@@ -412,30 +442,30 @@ | ||
| APIs added: | ||
| * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=node#list_invoices_for_a_customer. | ||
| * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/v1/transactions?lang=node#list_transactions_for_a_customer. | ||
| * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/invoices?lang=node#list_invoices_for_a_customer. | ||
| * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/transactions?lang=node#list_transactions_for_a_customer. | ||
| APIs updated: | ||
| * Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=node#create_invoice_for_charge. | ||
| * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=node#create_invoice_for_addon. | ||
| * Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/invoices?lang=node#create_invoice_for_charge. | ||
| * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/invoices?lang=node#create_invoice_for_addon. | ||
| ### v1.0.8 (2014-05-28) | ||
| * * * | ||
| New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions?lang=node. | ||
| New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/portal_sessions?lang=node. | ||
| ### v1.0.7 (2014-05-23) | ||
| * * * | ||
| * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer | ||
| * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/customers#create_a_customer | ||
| * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#list_invoices_for_a_customer | ||
| * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/invoices#list_invoices_for_a_customer | ||
| ### v1.0.6 (2014-03-26) | ||
| * * * | ||
| * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices. | ||
| * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices. | ||
| * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions. | ||
| * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions. | ||
| * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/v1/transactions#record_payment_for_an_invoice "Record Payment for an Invoice") | ||
| * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/transactions#record_payment_for_an_invoice "Record Payment for an Invoice") | ||
| ### v1.0.5 (2014-03-19) | ||
| * * * | ||
| Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/v1/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/v1/addons#delete_an_addon "Delete an addon"). | ||
| Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/addons#delete_an_addon "Delete an addon"). | ||
@@ -442,0 +472,0 @@ |
@@ -8,5 +8,5 @@ var ChargeBee = {}; | ||
| hostSuffix: '.chargebee.com', | ||
| apiPath: '/api/v1', | ||
| apiPath: '/api/v2', | ||
| timeout: 40000, | ||
| clientVersion: 'v1.3.4', | ||
| clientVersion: 'v2.0.0', | ||
| port: 443 | ||
@@ -13,0 +13,0 @@ }; |
@@ -174,20 +174,20 @@ var _endpoints = { | ||
| [ | ||
| "add_account_credits", | ||
| "add_promotional_credits", | ||
| "POST", | ||
| "/customers", | ||
| "/add_account_credits", | ||
| "/add_promotional_credits", | ||
| true | ||
| ], | ||
| [ | ||
| "deduct_account_credits", | ||
| "deduct_promotional_credits", | ||
| "POST", | ||
| "/customers", | ||
| "/deduct_account_credits", | ||
| "/deduct_promotional_credits", | ||
| true | ||
| ], | ||
| [ | ||
| "set_account_credits", | ||
| "set_promotional_credits", | ||
| "POST", | ||
| "/customers", | ||
| "/set_account_credits", | ||
| "/set_promotional_credits", | ||
| true | ||
@@ -312,6 +312,6 @@ ], | ||
| [ | ||
| "collect", | ||
| "close", | ||
| "POST", | ||
| "/invoices", | ||
| "/collect", | ||
| "/close", | ||
| true | ||
@@ -327,2 +327,9 @@ ], | ||
| [ | ||
| "record_payment", | ||
| "POST", | ||
| "/invoices", | ||
| "/record_payment", | ||
| true | ||
| ], | ||
| [ | ||
| "refund", | ||
@@ -356,2 +363,25 @@ "POST", | ||
| ], | ||
| "credit_note": [ | ||
| [ | ||
| "retrieve", | ||
| "GET", | ||
| "/credit_notes", | ||
| null, | ||
| true | ||
| ], | ||
| [ | ||
| "list", | ||
| "GET", | ||
| "/credit_notes", | ||
| null, | ||
| false | ||
| ], | ||
| [ | ||
| "credit_notes_for_customer", | ||
| "GET", | ||
| "/customers", | ||
| "/credit_notes", | ||
| true | ||
| ] | ||
| ], | ||
| "order": [ | ||
@@ -417,6 +447,6 @@ [ | ||
| [ | ||
| "transactions_for_invoice", | ||
| "payments_for_invoice", | ||
| "GET", | ||
| "/invoices", | ||
| "/transactions", | ||
| "/payments", | ||
| true | ||
@@ -430,9 +460,2 @@ ], | ||
| true | ||
| ], | ||
| [ | ||
| "record_payment", | ||
| "POST", | ||
| "/invoices", | ||
| "/record_payment", | ||
| true | ||
| ] | ||
@@ -470,16 +493,2 @@ ], | ||
| [ | ||
| "checkout_onetime_charge", | ||
| "POST", | ||
| "/hosted_pages", | ||
| "/checkout_onetime_charge", | ||
| false | ||
| ], | ||
| [ | ||
| "checkout_onetime_addons", | ||
| "POST", | ||
| "/hosted_pages", | ||
| "/checkout_onetime_addons", | ||
| false | ||
| ], | ||
| [ | ||
| "retrieve", | ||
@@ -486,0 +495,0 @@ "GET", |
| { | ||
| "name":"chargebee", | ||
| "version":"1.3.4", | ||
| "version":"2.0.0", | ||
| "description":"A library for integrating with ChargeBee.", | ||
@@ -5,0 +5,0 @@ "keywords":[ |
@@ -1,8 +0,8 @@ | ||
| # Chargebee Node Client Library - API V1 | ||
| # Chargebee Node Client Library - API V2 | ||
| The [node.js](http://nodejs.org/) library for integrating with Chargebee Recurring Billing and Subscription Management solution. | ||
| Chargebee now supports two API versions - [V1](https://apidocs.chargebee.com/docs/api/v1) and [V2](https://apidocs.chargebee.com/docs/api). This library is for our <b>older API version V1</b>. The library for V2 can be found in the [master branch](https://github.com/chargebee/chargebee-node). | ||
| Chargebee now supports two API versions - [V1](https://apidocs.chargebee.com/docs/api/v1) and [V2](https://apidocs.chargebee.com/docs/api), of which V2 is the latest release and all future developments will happen in V2. | ||
| You'd want to upgrade to V2 to benefit from the new functionality. Click here for the [API V2 Upgradation Guide](https://apidocs.chargebee.com/docs/api/v1#api-v2-upgradation-guide). | ||
| This library is for our <b>API version V2</b>. The library for V1 can be found in [chargebee-v1 branch](https://github.com/chargebee/chargebee-node/tree/chargebee-v1). | ||
@@ -12,9 +12,9 @@ | ||
| An attribute, <b>api_version</b>, is added to the [Event](https://apidocs.chargebee.com/docs/api/v1/events) resource, which indicates the API version based on which the event content is structured. In your webhook servers, ensure this _api_version_ is the same as the [API version](https://apidocs.chargebee.com/docs/api/v2#versions) used by your webhook server's client library. | ||
| An attribute, <b>api_version</b>, is added to the [Event](https://apidocs.chargebee.com/docs/api/events) resource, which indicates the API version based on which the event content is structured. In your webhook servers, ensure this _api_version_ is the same as the [API version](https://apidocs.chargebee.com/docs/api#versions) used by your webhook server's client library. | ||
| ## Installation | ||
| Install the latest version 1.x.x of the library with the following commands: | ||
| Install the latest version 2.x.x of the library with the following commands: | ||
| $ npm install chargebee@"<2" | ||
| $ npm install chargebee@">=2 <3" | ||
@@ -27,5 +27,7 @@ Then require the library as: | ||
| The full documentation can be found on the chargebee site [here](https://apidocs.chargebee.com/docs/api/v1/?lang=node). | ||
| The full documentation can be found on the chargebee site here: | ||
| [https://apidocs.chargebee.com/docs/api?lang=node](https://apidocs.chargebee.com/docs/api?lang=node) | ||
| ## License | ||
@@ -32,0 +34,0 @@ |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by5.99%
49364
- Lines of code
- increased by0.88%
1030
- Number of lines in readme file
- increased by6.06%
35
No dependency changes