chargebee 1.7.5 → 2.6.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1114 -98
- data/LICENSE +1 -1
- data/README.rdoc +22 -15
- data/chargebee.gemspec +27 -7
- data/lib/.DS_Store +0 -0
- data/lib/chargebee.rb +28 -2
- data/lib/chargebee/environment.rb +11 -6
- data/lib/chargebee/errors.rb +1 -1
- data/lib/chargebee/models/addon.rb +18 -3
- data/lib/chargebee/models/address.rb +1 -1
- data/lib/chargebee/models/card.rb +8 -7
- data/lib/chargebee/models/comment.rb +1 -1
- data/lib/chargebee/models/contact.rb +11 -0
- data/lib/chargebee/models/coupon.rb +20 -4
- data/lib/chargebee/models/coupon_code.rb +9 -1
- data/lib/chargebee/models/coupon_set.rb +38 -0
- data/lib/chargebee/models/credit_note.rb +79 -0
- data/lib/chargebee/models/credit_note_estimate.rb +36 -0
- data/lib/chargebee/models/customer.rb +73 -12
- data/lib/chargebee/models/estimate.rb +26 -15
- data/lib/chargebee/models/event.rb +1 -1
- data/lib/chargebee/models/export.rb +87 -0
- data/lib/chargebee/models/gift.rb +43 -0
- data/lib/chargebee/models/hierarchy.rb +10 -0
- data/lib/chargebee/models/hosted_page.rb +33 -5
- data/lib/chargebee/models/invoice.rb +83 -19
- data/lib/chargebee/models/invoice_estimate.rb +36 -0
- data/lib/chargebee/models/model.rb +34 -3
- data/lib/chargebee/models/order.rb +49 -3
- data/lib/chargebee/models/payment_source.rb +84 -0
- data/lib/chargebee/models/plan.rb +33 -5
- data/lib/chargebee/models/promotional_credit.rb +31 -0
- data/lib/chargebee/models/quote.rb +77 -0
- data/lib/chargebee/models/resource_migration.rb +14 -0
- data/lib/chargebee/models/site_migration_detail.rb +15 -0
- data/lib/chargebee/models/subscription.rb +60 -8
- data/lib/chargebee/models/subscription_estimate.rb +14 -0
- data/lib/chargebee/models/third_party_payment_method.rb +10 -0
- data/lib/chargebee/models/time_machine.rb +47 -0
- data/lib/chargebee/models/token.rb +11 -0
- data/lib/chargebee/models/transaction.rb +29 -10
- data/lib/chargebee/models/unbilled_charge.rb +32 -0
- data/lib/chargebee/models/virtual_bank_account.rb +32 -0
- data/lib/chargebee/request.rb +11 -0
- data/lib/chargebee/rest.rb +6 -4
- data/lib/chargebee/result.rb +183 -27
- data/spec/errors_spec.rb +23 -0
- data/spec/sample_response.rb +1 -1
- metadata +39 -11
- data/lib/chargebee/models/payment_intent.rb +0 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e72845bfae886cfae200f19c93d6274a3d4b3715
|
4
|
+
data.tar.gz: 0e763b87a880276de62533dc2f52b120284e5a66
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f391854b80eb235c4b6bbddc8fd8eee332bfd5d27708bc02823d6f7114ebcb3a92cf48315493e675f9032971484bc59b9d61a937c6fac578d6d41b87e61e8a37
|
7
|
+
data.tar.gz: eb7f75bdfc5bedf18af1aed1b43779255750693624f2be449a18b6477dbe951c94e4484213cf79523aa8185d648f02aaa60465cecb085ded8d8a412305d27629
|
data/CHANGELOG.md
CHANGED
@@ -1,26 +1,1042 @@
|
|
1
|
-
###
|
1
|
+
### v2.6.8 (2019-08-07)
|
2
2
|
* * *
|
3
3
|
|
4
|
-
* New
|
5
|
-
* New
|
6
|
-
* New
|
4
|
+
* 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.
|
5
|
+
* New attributes sub_total_in_local_currency, total_in_local_currency and local_currency_code have been added in credit_note and invoice resources.
|
6
|
+
* 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.
|
7
|
+
* New attributes name, invoice_id and notes have been added in quote resource.
|
8
|
+
* 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.
|
9
|
+
* New input parameters id, auto_collection and po_number have been added in convert_a_quote api.
|
7
10
|
|
8
|
-
###
|
11
|
+
### v2.6.7 (2019-07-22)
|
9
12
|
* * *
|
10
13
|
|
11
|
-
*
|
12
|
-
*
|
13
|
-
*
|
14
|
+
* The attribute ref_tx_id has been added in card resource.
|
15
|
+
* The attribute custmer_id has been added in credit_note_estimate and invoice_estimate resource.
|
16
|
+
* 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.
|
17
|
+
* New enum dunning_type has been added.
|
18
|
+
* New value vantiv has been added in the gateway enum.
|
19
|
+
* New value sepa_credit has been added in payment method enum.
|
20
|
+
* The attribute dunning_attempts has been added in invoice resource.
|
21
|
+
* New enpoint create_using_payment_intent has been added in payment_source resouce.
|
22
|
+
* The input parameter reference_transaction has been added in update card payment source API.
|
23
|
+
* New endpoint list quote has been added in qoutes resource.
|
24
|
+
* The attributes initiator_type and three_d_secure have been added in transaction resource.
|
25
|
+
* New attribute scheme has been added in virtual_bank_account resource.
|
26
|
+
* New input parameter scheme has been added in create a virtual bank account using permanent token and create a virtual bank account API.
|
14
27
|
|
15
|
-
###
|
28
|
+
### v2.6.6 (2019-07-08)
|
16
29
|
* * *
|
17
30
|
|
18
|
-
*
|
19
|
-
*
|
20
|
-
* The
|
21
|
-
* The
|
22
|
-
*
|
23
|
-
*
|
31
|
+
* The resources hierarchy and token are added.
|
32
|
+
* Value ‘day’ is added in period_unit and shipping_frequency_period_unit .
|
33
|
+
* The parameters fractional_correction, comment, date_from and date_to are added in Create credit note API.
|
34
|
+
* The attribute customer_id is added to line_item sub resource of Credit note, Credit note estimate, Invoice, Invoice estimate and Quote.
|
35
|
+
* Endpoints Link a customer, Delink a customer, Get hierarchy, CreateUsingToken are added.
|
36
|
+
* The attributes business_customer_without_vat_number and relationship are added to customer resource.
|
37
|
+
* 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.
|
38
|
+
* The parameter token_id is added in Collect payment API.
|
39
|
+
* Event types hierarchy_created, hierarchy_deleted, token_created, token_consumed and token_expired are added.
|
40
|
+
* 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.
|
41
|
+
* The filter parameter payment_owner is added in Export revenue recognition reports,Export Deferred Revenue Reports, Export Invoice and List Invoice APIs.
|
42
|
+
* The attribute payment_owner is added to invoice.
|
43
|
+
* 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.
|
44
|
+
* The parameter comment is added to Stop dunning, Apply payments, Apply credits, Add charge, Add add-on charge, Update details and Close Invoice APIs.
|
45
|
+
* The parameter ‘claim_credits’ is added to delete invoice API.
|
46
|
+
* The attribute override_relationship is added to subscription resource.
|
47
|
+
* The parameter token_id is added to Create subscription API.
|
48
|
+
* The parameter override_relationship is added to Create subscription for customer and Update subscription APIs.
|
49
|
+
* The attribute service_period_in_days is added to event add ons sub resource.
|
50
|
+
|
51
|
+
### v2.6.5 (2019-04-11)
|
52
|
+
* * *
|
53
|
+
|
54
|
+
* The attributes avalara_sale_type, avalara_transaction_type and avalara_service_type are added in Addon and plan resource.
|
55
|
+
* 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.
|
56
|
+
* 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.
|
57
|
+
* The attributes exemption_details and customer_type are added in customer resource .
|
58
|
+
* 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.
|
59
|
+
* The enum values federal and unincorporated are added in tax_juris_type.
|
60
|
+
* The enum value export is added in tax_override_reason .
|
61
|
+
* The input parameter cancelled_at is added in cancel order api endpoint.
|
62
|
+
* New endpoint delete_local is added in payment_source and virtual_bank_account resources.
|
63
|
+
|
64
|
+
### v2.6.4 (2019-03-22)
|
65
|
+
* * *
|
66
|
+
|
67
|
+
* #to_s in Result is made public.
|
68
|
+
|
69
|
+
### v2.6.3 (2019-03-07)
|
70
|
+
* * *
|
71
|
+
|
72
|
+
* The attributes created_at, resource_version and updated_at are added in card, payment_source and virtual_bank_account resources.
|
73
|
+
* The input filter parameter sort_by with updated_at attribute is added in list customer and list subscription api endpoints.
|
74
|
+
* New endpoint export orders is added in export resource.
|
75
|
+
* New endpoint accept quote is added in hosted_pages resource.
|
76
|
+
* The input filter parameters updated_at and created_at are added in list payment_source api endpoint and list virtual_bank_accounts endpoint .
|
77
|
+
* New endpoint delete an offline transaction is added in transaction resource.
|
78
|
+
|
79
|
+
### v2.6.2 (2019-01-10)
|
80
|
+
* * *
|
81
|
+
|
82
|
+
* New event type 'quote_deleted' has been added
|
83
|
+
* New gateway type 'cybersource' has been added.
|
84
|
+
* New filter parameters 'subscription_id' and 'order_type' have been added in List Order API.
|
85
|
+
* New endpoints Create subscription for customer quote, Update subscription quote and Delete have been added to Quote resource.
|
86
|
+
|
87
|
+
### v2.6.1 (2018-11-09)
|
88
|
+
* * *
|
89
|
+
|
90
|
+
* 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
|
91
|
+
* Entity type 'quote' has been added.
|
92
|
+
* Event types 'quote_created' and 'quote_updated' have been added.
|
93
|
+
|
94
|
+
|
95
|
+
### v2.6.0 (2018-11-02)
|
96
|
+
* * *
|
97
|
+
|
98
|
+
* New resource 'Gift' with endpoints 'Create a gift', 'Retrieve a gift', 'Claim a gift', 'Cancel a gift' and 'List gifts' has been added.
|
99
|
+
* New event types gift_scheduled, gift_unclaimed, gift_claimed, gift_expired and gift_cancelled have been added.
|
100
|
+
* New endpoints 'Checkout gift' and 'Claim gift' have been added to Hosted page resource.
|
101
|
+
* Input param 'redirect_url' has been added in 'Manage payment sources' and 'Collect now' APIs.
|
102
|
+
* Hosted page types 'checkout_gift' and 'claim_gift' have been added.
|
103
|
+
* The attributes 'term_finalized' and 'is_gifted' have been added in Invoice attributes.
|
104
|
+
* The attributes 'is_gifted', 'gift_note' and 'gift_id' have been added in Orders attributes.
|
105
|
+
* The attribute 'sku' has been added in Gift attributes.
|
106
|
+
* The input parameter 'sku' has been added in Update orders API.
|
107
|
+
* The order status 'cancelled' has been added.
|
108
|
+
* The attributes 'giftable' and 'claim_url' have been added in Plan resource.
|
109
|
+
* The input parameters 'giftable' and 'claim_url' have been added in Create a plan API.
|
110
|
+
* List filter parameter 'giftable' has been added in List Plans API.
|
111
|
+
* The attribute 'gift_id' has been added to Subscription resource.
|
112
|
+
|
113
|
+
### v2.5.9 (2018-10-26)
|
114
|
+
* * *
|
115
|
+
|
116
|
+
* The attributes authorization_reason, reference_authorization_id, amount_capturable and linked_payments have been added in Transaction resource.
|
117
|
+
* The input parameter transaction amount_capturable has been added in export transaction API.
|
118
|
+
* The input parameters authorization_transaction_id and auto_collection have been added in create invoice API.
|
119
|
+
* The input parameter authorization_transaction_id has been added in Collect payment for invoice API.
|
120
|
+
* Type authorization_reason with values blocking_funds and verification has been added in Transaction resource.
|
121
|
+
* New endpoints "Create an authorization payment " and "Void an authorization transaction" have been in added in Transaction API.
|
122
|
+
* The input filter parameter amount_capturable has been added in list transactions API.
|
123
|
+
* The Event types authorization_succeeded, authorization_voided, order_ready_to_process, order_ready_to_ship have been added.
|
124
|
+
|
125
|
+
### v2.5.8 (2018-10-17)
|
126
|
+
* * *
|
127
|
+
|
128
|
+
* The attributes pricing_model and tiers has been added in Addon , Plan and UnbilledCharge resources.
|
129
|
+
* The attribute price is made optional in Plan and Addon resource.
|
130
|
+
* 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.
|
131
|
+
* The attributes line_item_tiers would be added in creditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
|
132
|
+
* The attribute pricing_model have been added to line_tem sub-resource of CreditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
|
133
|
+
* The input parameter line_item_amount has been added in Create credit note API.
|
134
|
+
* The input parameters line_item_unit_amount and line_item_quantity have been changed to optional parameters in Create Credit Note API.
|
135
|
+
* 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.
|
136
|
+
* The attribute amount has been added to Addon subResource attributes of Subscription API.
|
137
|
+
* The attribute plan_amount has been added to Subscription API.
|
138
|
+
* The type pricing_model with values flat_fee, per_unit, tiered, volume and stairstep have been added.
|
139
|
+
* The values tiered, volume and stairstep have been added the attribute type of Addon resource.
|
140
|
+
* The values tiered, volume and stairstep have been added to the attribute charge_model of Plan resource.
|
141
|
+
* The input parameter type has been deprecated in Create Addon and Update Addon APIs.
|
142
|
+
* The input parameter charge_model has been deprecated in Create Plan and Update Plan APIs.
|
143
|
+
* The filter parameter type has been deprecated in List Addon API.
|
144
|
+
* The filter parameter charge_model has been deprecated in List Plan API.
|
145
|
+
* The filter parameter pricing_model has been added to List Plan and List Addon APIs.
|
146
|
+
|
147
|
+
### v2.5.7 (2018-10-03)
|
148
|
+
* * *
|
149
|
+
|
150
|
+
* The attributes `is_shippable`, `shipping_frequency_period` and`shipping_frequency_period_unit` has been added in Plan and Addon resource.
|
151
|
+
* The input parameters `is_shippable`, `shipping_frequency_period` and`shipping_frequency_period_unit` has been added in Create plan , Update plan , Create addonand Update addon APIs.
|
152
|
+
* The attributes `vat_number_validated_time`, `vat_number_status` and `is_location_valid`has been added in Customer resource.
|
153
|
+
* The event types `order_created`, `order_updated`, `order_cancelled`, `order_delivered`and `order_returned` has been added.
|
154
|
+
* New order status `queued`, `awaiting_shipment`, `on_hold`, `delivered`, `shipped`,`partially_delivered` and `returned` has been added.
|
155
|
+
* 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.
|
156
|
+
* The input parameter `subscription_affiliate_token` has been added to Checkout New Hosted Pages API.
|
157
|
+
* The attributes `document_number` and `order_type` has been added to Invoice resource.
|
158
|
+
* The attributes `document_number`, `customer_id`, `subscription_id`,`cancellation_reason`, `payment_status`, `order_type`, `price_type`, `order_date`,`shipping_date`, `shipment_carrier`, `invoice_round_off_amount`, `tax`, `amount_paid`,`amount_adjusted`, `refundable_credits_issued`, `refundable_credits`,`rounding_adjustement`, `paid_on`, `shipping_cut_off_date`, `delivered_at`,`shipped_at`, `resource_verison`, `updated_at`, `cancelled_at`, `order_line_items`,`shipping_address`, `billing_address`, `discount`, `sub_total`, `total`,`line_item_taxes`, `line_item_discounts`, `linked_credit_notes`, `deleted` and`currency_code` has been added in Order resource.
|
159
|
+
* 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.
|
160
|
+
* The filters `include_deleted`, `shipping_date`, `order_date`, `paid_on` and `updated_at` has been added in List Orders API.
|
161
|
+
* New endpoints Assign order number , Cancel an order , Create a refundable credit note and Reopen a cancelled order has been added to Orders API.
|
162
|
+
|
163
|
+
### v2.5.6 (2018-09-12)
|
164
|
+
* * *
|
165
|
+
* The attributes addon_applicability, applicable_addons, attached_addons and event_based_addons has been added to Plan resource.
|
166
|
+
* The input parameters addon_applicability, applicable_addons, attached_addons and event_based_addons has been added in Create and Update plan APIs.
|
167
|
+
* The attributes event_based_addons and charged_event_based_addons has been added to Subscription resource.
|
168
|
+
* 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.
|
169
|
+
|
170
|
+
|
171
|
+
### v2.5.5 (2018-08-17)
|
172
|
+
* * *
|
173
|
+
|
174
|
+
* New endpoint 'Clear Personal Data of a customer' has been added to Customer resource.
|
175
|
+
* New endpoint 'Merge customers' has been added to Customer resource.
|
176
|
+
* New endpoint 'Extend subscription' has been added to Hosted page resource.
|
177
|
+
* The input parameter 'charges_handling' has been added to Resume a subscription and Resume a subscription estimate APIs.
|
178
|
+
* The input parameters 'pause_date' and 'resume_date' has been added to Import subscription and Import subscription for customer APIs.
|
179
|
+
* New tax_exempt_reason 'high_value_physical_goods' has been be added.
|
180
|
+
|
181
|
+
### v2.5.4 (2018-06-21)
|
182
|
+
* * *
|
183
|
+
|
184
|
+
* New attribute round_off_amount is added in Credit Note Estimate, Invoice Estimate Object
|
185
|
+
* Sort List Invoice API results based on invoice updated_at attribute.
|
186
|
+
* Create Customer and Create Subscription additionally take bank account details as input parameter.
|
187
|
+
* New API end point in Hosted Page resource to retrieve direct debit agreement payment PDF
|
188
|
+
* New Enum AccountHolderType, AccountType, Echeck Type has been added in Payment Source
|
189
|
+
* New attribute echeck, account_holder_type, last4 has been added
|
190
|
+
* New API end points create bank account payment source and verify bank account payment source has been added
|
191
|
+
|
192
|
+
|
193
|
+
### v2.5.3 (2018-05-23)
|
194
|
+
* * *
|
195
|
+
|
196
|
+
* New Resource [Export](https://apidocs.chargebee.com/docs/api/exports) has been added
|
197
|
+
* New payment gateway bluesnap has been added
|
198
|
+
|
199
|
+
### v2.5.1 (2018-05-14)
|
200
|
+
* * *
|
201
|
+
|
202
|
+
New endpoint 'List contacts for a customer' has been added to Customer resource.
|
203
|
+
See : https://apidocs.chargebee.com/docs/api/customers#list_of_contacts_for_a_customer
|
204
|
+
|
205
|
+
### v2.5.0 (2018-05-03)
|
206
|
+
* * *
|
207
|
+
|
208
|
+
New endpoint 'Update a coupon' has been added.
|
209
|
+
See : https://apidocs.chargebee.com/docs/api/coupons#update_a_coupon
|
210
|
+
|
211
|
+
### v2.4.9 (2018-04-27)
|
212
|
+
* * *
|
213
|
+
|
214
|
+
New resource 'Virtual Bank Account' has been added.
|
215
|
+
See : https://apidocs.chargebee.com/docs/api/virtual_bank_accounts
|
216
|
+
|
217
|
+
New event types virtual_bank_account_added, virtual_bank_account_updated and virtual_bank_account_deleted has been added.
|
218
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_types
|
219
|
+
|
220
|
+
The payment method ach_credit has been added.
|
221
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
222
|
+
|
223
|
+
### v2.4.8 (2018-03-29)
|
224
|
+
* * *
|
225
|
+
|
226
|
+
New status 'Pause' has been added to subscription.
|
227
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_status
|
228
|
+
|
229
|
+
The attribues 'pause_date' and 'resume_date' have been added to subscription and estimate resources.
|
230
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
231
|
+
|
232
|
+
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.
|
233
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription
|
234
|
+
|
235
|
+
The attribute 'expected_payment_date' has been added to Invoice attributes.
|
236
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
237
|
+
|
238
|
+
The reason code 'subscription_pause' has been added to Credit note attributes.
|
239
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_reason_code
|
240
|
+
|
241
|
+
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.
|
242
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_types
|
243
|
+
|
244
|
+
New endpoints 'Pause a subscription', 'Resume a subscription', 'Remove scheduled pause' and 'Remove scheduled resumption' have been added to Subscription resource.
|
245
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions
|
246
|
+
|
247
|
+
New endpoints 'Pause subscription estimate' and 'Resume subscription estimate' have been added to Estimate resource.
|
248
|
+
See : https://apidocs.chargebee.com/docs/api/estimates
|
249
|
+
|
250
|
+
### v2.4.7 (2018-03-20)
|
251
|
+
* * *
|
252
|
+
|
253
|
+
New attribute 'deleted' has been added to Payment source resource.
|
254
|
+
See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_attributes
|
255
|
+
|
256
|
+
### v2.4.6 (2018-03-08)
|
257
|
+
* * *
|
258
|
+
|
259
|
+
The input parameter disposition_type has been added to 'Retrieve Invoice as PDF' and 'Retrieve Credit Note as PDF' APIs.
|
260
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#retrieve_invoice_as_pdf
|
261
|
+
|
262
|
+
### v2.4.5 (2018-03-02)
|
263
|
+
* * *
|
264
|
+
|
265
|
+
The attribute 'balance_currency_code' has been deprecated and attribute 'currency_code' has been added to Balances sub-resource in Customer resource.
|
266
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
267
|
+
|
268
|
+
The attribute done_by has been added to Promotional credits resource.
|
269
|
+
See : https://apidocs.chargebee.com/docs/api/promotional_credits
|
270
|
+
|
271
|
+
New payment method wechat_pay has been added.
|
272
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
273
|
+
|
274
|
+
The endpoint Manage Payment Sources has been undeprecated in Hosted pages resource.
|
275
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages
|
276
|
+
|
277
|
+
### v2.4.4 (2018-02-01)
|
278
|
+
* * *
|
279
|
+
|
280
|
+
The attribute 'round_off_amount' have been added in Invoice an Credit note resources.
|
281
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
282
|
+
|
283
|
+
The attribute 'settled_at' has been added to transaction resource.
|
284
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
285
|
+
|
286
|
+
'Collect now' API in Hosted pages resource has been undeprecated.
|
287
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages#collect_now
|
288
|
+
|
289
|
+
### v2.4.3 (2018-01-12)
|
290
|
+
* New endpoint "Update invoice details" has been added to Invoice resource.
|
291
|
+
|
292
|
+
### v2.4.2 (2017-11-27)
|
293
|
+
* * *
|
294
|
+
|
295
|
+
** API changes **:
|
296
|
+
* The new resource [Promotional Credits](http://apidocs.chargebee.com/docs/api/promotional_credits) has been added
|
297
|
+
|
298
|
+
* The new sub resource [balances](https://apidocs.chargebee.com/docs/api/customers#customer_balances) has been added
|
299
|
+
|
300
|
+
* The API end point add_promotional_credits, deduct_promotional_credits and set_promotional_credits has been deprecated in customer resource
|
301
|
+
|
302
|
+
** Events added**:
|
303
|
+
* New Event Type promotional_credits_added and promotional_credits_deducted has been added
|
304
|
+
|
305
|
+
### v2.4.1 (2017-11-13)
|
306
|
+
* * *
|
307
|
+
|
308
|
+
** API changes**:
|
309
|
+
* The new resource [Coupon Set](https://apidocs.chargebee.com/docs/api/coupon_sets) has been added
|
310
|
+
|
311
|
+
* The API end point create a coupon code for a coupon has been deprecated in coupon code resource
|
312
|
+
|
313
|
+
* The attribute [coupon_set_id](https://apidocs.chargebee.com/docs/api/coupon_codes#coupon_code_coupon_set_id) has been added to Coupon Code resource
|
314
|
+
|
315
|
+
* The deprecation has been removed for [Collect payment for customer](https://apidocs.chargebee.com/docs/api/customers#collect_payment_for_customer) in customer resource
|
316
|
+
|
317
|
+
* 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
|
318
|
+
|
319
|
+
** Attributes added**:
|
320
|
+
* New attribute [remaining_billing_cycles](https://apidocs.chargebee.com/docs/api/subscriptions#subscription_addons_remaining_billing_cycles) has been added in addons under subscription resource.
|
321
|
+
|
322
|
+
|
323
|
+
** Events added**:
|
324
|
+
* New event type coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_updated, coupon_codes_deleted
|
325
|
+
|
326
|
+
### v2.4.0 (2017-09-22)
|
327
|
+
* * *
|
328
|
+
|
329
|
+
** APIs added**:
|
330
|
+
|
331
|
+
New endpoint 'Collect payment for a customer' has been added as a restricted and deprecated API.
|
332
|
+
|
333
|
+
** APIs updated**:
|
334
|
+
|
335
|
+
The attribute 'amount_to_collect' would be added to Invoice resource.
|
336
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
337
|
+
|
338
|
+
### v2.3.9 (2017-09-15)
|
339
|
+
* * *
|
340
|
+
|
341
|
+
** APIs updated**:
|
342
|
+
|
343
|
+
The attribute payment_source_id would be added to the transaction resource.
|
344
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#transaction_payment_source_id
|
345
|
+
|
346
|
+
The filter parameter payment_source_id would be added in List transactions API.
|
347
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#list_transactions
|
348
|
+
|
349
|
+
The gateway types amazon_payments and paypal_express_checkout would be added.
|
350
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_payment_method_gateway
|
351
|
+
|
352
|
+
### v2.3.8 (2017-09-14)
|
353
|
+
* * *
|
354
|
+
|
355
|
+
** APIs updated**:
|
356
|
+
|
357
|
+
The attribute registered_for_gst has been added to the Customer resource.
|
358
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
359
|
+
|
360
|
+
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.
|
361
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
362
|
+
|
363
|
+
### v2.3.7 (2017-09-06)
|
364
|
+
* * *
|
365
|
+
|
366
|
+
** APIs added**:
|
367
|
+
|
368
|
+
The new endpoint Record refund for a credit note has been added to Credit note resource.
|
369
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes#record_refund_for_a_credit_note
|
370
|
+
|
371
|
+
** APIs updated**:
|
372
|
+
|
373
|
+
The parameter tmp_token has been deprecated in card subresource in Create a customer , Create a subscription , Update a subscription and Import subscription APIs.
|
374
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
375
|
+
|
376
|
+
The parameter tmp_token has been added to payment method subresource in Create a subscription API.
|
377
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription
|
378
|
+
|
379
|
+
The type apple_pay has been added to payment method types.
|
380
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer_payment_method_type
|
381
|
+
|
382
|
+
### v2.3.6 (2017-08-31)
|
383
|
+
* * *
|
384
|
+
|
385
|
+
** APIs added**:
|
386
|
+
|
387
|
+
The parameters credit_option_for_current_term_charges, unbilled_charges_option,refundable_credits_handling and account_receivables_handling would be added inCancel subscription API.
|
388
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#cancel_a_subscription
|
389
|
+
|
390
|
+
A new endpoint Cancel subscription estimate would be added to the Estimate resource.
|
391
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#cancel_subscription_estimate
|
392
|
+
|
393
|
+
The attribute deleted would be added to the Unbilled charge resource.
|
394
|
+
See : https://apidocs.chargebee.com/docs/api/unbilled_charges#unbilled_charge_attributes
|
395
|
+
|
396
|
+
The parameter include_deleted would be added in List Unbilled Charges API.
|
397
|
+
See : https://apidocs.chargebee.com/docs/api/unbilled_charges#list_unbilled_charges
|
398
|
+
|
399
|
+
|
400
|
+
### v2.3.5 (2017-08-28)
|
401
|
+
* * *
|
402
|
+
|
403
|
+
** APIs added**:
|
404
|
+
|
405
|
+
The endpoints Void a credit note and Delete a credit note would be added to the Credit notes resource.
|
406
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes
|
407
|
+
|
408
|
+
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.w
|
409
|
+
See : https://apidocs.chargebee.com/docs/api/invoices
|
410
|
+
|
411
|
+
### v2.3.4 (2017-08-16)
|
412
|
+
* * *
|
413
|
+
|
414
|
+
** APIs added**:
|
415
|
+
|
416
|
+
A new endpoint 'Update a card payment source' would be added to the Payment source resource.
|
417
|
+
See : https://apidocs.chargebee.com/docs/api/payment_sources#update_a_card_payment_source
|
418
|
+
|
419
|
+
### v2.3.3 (2017-08-03)
|
420
|
+
* * *
|
421
|
+
|
422
|
+
** APIs updated**:
|
423
|
+
|
424
|
+
The attribute trial_end has been added to Subscriptions Addon subresource.
|
425
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_addons_trial_end
|
426
|
+
|
427
|
+
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.
|
428
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription_addons_trial_end
|
429
|
+
|
430
|
+
### v2.3.2 (2017-07-26)
|
431
|
+
* * *
|
432
|
+
|
433
|
+
** APIs added**:
|
434
|
+
|
435
|
+
The new resource 'Time Machine' has been added.
|
436
|
+
|
437
|
+
### v2.3.1 (2017-07-21)
|
438
|
+
* * *
|
439
|
+
|
440
|
+
** APIs added**:
|
441
|
+
|
442
|
+
The new endpoint 'Change Billing Date' has been added to Customer resource.
|
443
|
+
See : https://apidocs.chargebee.com/docs/api/customers#change_billing_date
|
444
|
+
|
445
|
+
The new endpoints 'Upcoming invoices estimate' and 'Subscription change term end estimate' have been added to Estimate API.
|
446
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#upcoming_invoices_estimate
|
447
|
+
|
448
|
+
** APIs updated**:
|
449
|
+
|
450
|
+
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.
|
451
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
452
|
+
|
453
|
+
The event types 'unbilled_charges_created', 'unbilled_charges_voided', 'unbilled_charges_deleted' and 'unbilled_charges_invoiced' have been added.
|
454
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_types
|
455
|
+
|
456
|
+
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.
|
457
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription
|
458
|
+
|
459
|
+
The parameters 'line_item_date_from' and 'line_item_date_to' have been added to Add Charge API.
|
460
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#add_charge_item_to_pending_invoice
|
461
|
+
|
462
|
+
The parameters 'prorate' and 'invoice_immediately' have been added Change term end API.
|
463
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#change_term_end
|
464
|
+
|
465
|
+
### v2.3.0 (2017-07-06)
|
466
|
+
* * *
|
467
|
+
|
468
|
+
** APIs updated**:
|
469
|
+
|
470
|
+
The parameter "status" has been added to the Create a plan, Create an addon and Create a coupon APIs.
|
471
|
+
See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
|
472
|
+
|
473
|
+
The attribute "issuing_country" has been added to the Card and Payment source resource.
|
474
|
+
See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_attributes
|
475
|
+
|
476
|
+
The reason code "fraudulent" has been added to the Credit note resource.
|
477
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_reason_code
|
478
|
+
|
479
|
+
The attribute "bank_name" is made optional in Bank Account subresource.
|
480
|
+
See : https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_bank_account_bank_name
|
481
|
+
|
482
|
+
The parameter "redirect_url" has been made optional in Create a portal session API.
|
483
|
+
See : https://apidocs.chargebee.com/docs/api/portal_sessions#create_a_portal_session
|
484
|
+
|
485
|
+
The attributes "fraud_flag" and "fraud_reason" have been added to the Transaction resource.
|
486
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
487
|
+
|
488
|
+
|
489
|
+
### v2.2.9 (2017-06-01)
|
490
|
+
* * *
|
491
|
+
|
492
|
+
The endpoint Invoice Now Estimate has been added to the Unbilled Charge resource.
|
493
|
+
See : https://apidocs.chargebee.com/docs/api/customers#assign_payment_role
|
494
|
+
|
495
|
+
** APIs updated**:
|
496
|
+
|
497
|
+
The filter param "phone" has been added to the List Customer API.
|
498
|
+
See : https://apidocs.chargebee.com/docs/api/customers#list_customers
|
499
|
+
|
500
|
+
The subresource "invoice_estimates" has been added to the Estimate resource.
|
501
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#invoice_estimate_attributes
|
502
|
+
|
503
|
+
### v2.2.8 (2017-05-04)
|
504
|
+
* * *
|
505
|
+
|
506
|
+
** APIs added**:
|
507
|
+
The new resources Payment Source has been added.
|
508
|
+
See: https://apidocs.chargebee.com/docs/api/payment_sources
|
509
|
+
|
510
|
+
The new resources Unbilled Charge has been added.
|
511
|
+
See : https://apidocs.chargebee.com/docs/api/unbilled_charges
|
512
|
+
|
513
|
+
The endpoint Assign payment role has been added to the Customer resource.
|
514
|
+
See : https://apidocs.chargebee.com/docs/api/customers#assign_payment_role
|
515
|
+
|
516
|
+
The endpoint Override Billing Profile has been added to the Subscription resource.
|
517
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#override_billing_profile
|
518
|
+
|
519
|
+
|
520
|
+
** APIs updated**:
|
521
|
+
The attribute payment_source_id has been added to the Card resource.
|
522
|
+
See : https://apidocs.chargebee.com/docs/api/cards#card_attributes
|
523
|
+
|
524
|
+
The attribute subscription_id has been added to the lineitems subresource in Invoice , Credit Note , Invoice estimate , Next invoice estimate and Credit Note estimate .
|
525
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
526
|
+
|
527
|
+
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.
|
528
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
529
|
+
|
530
|
+
The attributes payment_source_id and auto_collection have been added to the Subscription resource.
|
531
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
532
|
+
|
533
|
+
The subresource unbilled_charge_estimates has been added to the Estimate resource.
|
534
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#unbilled_charge_estimate_attributes
|
535
|
+
|
536
|
+
The param consolidated_invoicing has been added to Create a customer and Update a customer APIs.
|
537
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
538
|
+
|
539
|
+
The input params auto_collection, invoice_immediately and consolidated_invoicing have been added to Create subscription API.
|
540
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription
|
541
|
+
|
542
|
+
The input params auto_collection, payment_source_id and invoice_immediately have been added to Create subscription for customer API.
|
543
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_subscription_for_customer
|
544
|
+
|
545
|
+
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.
|
546
|
+
See : https://apidocs.chargebee.com/docs/api/customers#add_promotional_credits_to_a_customer
|
547
|
+
|
548
|
+
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.
|
549
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription
|
550
|
+
|
551
|
+
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.
|
552
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
|
553
|
+
|
554
|
+
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.
|
555
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription
|
556
|
+
|
557
|
+
The event types payment_source_added, payment_source_updated and payment_source_deleted have been added.
|
558
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_types
|
559
|
+
|
560
|
+
### v2.2.7 (2017-04-19)
|
561
|
+
* * *
|
562
|
+
|
563
|
+
** APIs added**:
|
564
|
+
The endpoints 'List' and 'Acknowledge' APIs have been added to the Hosted page resource.
|
565
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages
|
566
|
+
|
567
|
+
** APIs updated**:
|
568
|
+
A new subresource 'line_item_discounts' has been added to the Invoice, Credit note, Invoice estimates and Credit note estimates resources.
|
569
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
570
|
+
|
571
|
+
The Card statuses 'pending_verification' and 'invalid' have been added to the Customer resource.
|
572
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
573
|
+
|
574
|
+
The Payment Method types 'generic', 'alipay' and 'unionpay' have been added to the Payment Method type in the Customer resource.
|
575
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
576
|
+
|
577
|
+
The state 'failed' and the attribute 'failure_reason' have been deprecated in the Hosted Page resource.
|
578
|
+
|
579
|
+
The attribues 'updated_at', 'resource_version' and 'checkout_info' have been added.
|
580
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages#hosted_page_attributes
|
581
|
+
|
582
|
+
A new gateway 'adyen' has been added.
|
583
|
+
See : https://apidocs.chargebee.com/docs/api/cards#card_attributes
|
584
|
+
|
585
|
+
### v2.2.6 (2017-03-16)
|
586
|
+
* * *
|
587
|
+
|
588
|
+
** APIs updated**:
|
589
|
+
The input parameter 'id' have been removed in Update a Plan and Update an addon resources.
|
590
|
+
See: https://apidocs.chargebee.com/docs/api/plans#update_a_plan
|
591
|
+
|
592
|
+
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.
|
593
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_subscription_for_customer
|
594
|
+
|
595
|
+
The filter input parameter 'next_billing_at' have been added in List Subscriptions API.
|
596
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#list_subscriptions
|
597
|
+
|
598
|
+
The input parameter 'force_term_reset' have been added to Checkout existing hosted pages API.
|
599
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_existing_subscription
|
600
|
+
|
601
|
+
A new attribute 'has_advance_charges' have been added to the Invoice resource.
|
602
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
603
|
+
|
604
|
+
|
605
|
+
### v2.2.5 (2017-02-24)
|
606
|
+
* * *
|
607
|
+
|
608
|
+
** APIs added**:
|
609
|
+
New resources 'Site Migration Details' and 'Resource Migrations' have been added.
|
610
|
+
See : https://apidocs.chargebee.com/docs/api/site_migration_details
|
611
|
+
|
612
|
+
A new endpoint 'Move a customer' has been added.
|
613
|
+
See : https://apidocs.chargebee.com/docs/api/customers#move_a_customer
|
614
|
+
|
615
|
+
** APIs updated**:
|
616
|
+
The attributes 'id' and 'for_site_merging' have been added to Copy an addon, Copy a coupon and Copy a plan API.
|
617
|
+
See : https://apidocs.chargebee.com/docs/api/plans#copy_a_plan
|
618
|
+
|
619
|
+
The event types 'customer_moved_out' and 'customer_moved_in' have been added.
|
620
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_types
|
621
|
+
|
622
|
+
The input parameters 'ignore_scheduled_cancellation' and 'ignore_scheduled_changes' have been added to the Subscription renewal estimate API.
|
623
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate
|
624
|
+
|
625
|
+
|
626
|
+
### v2.2.4 (2017-01-30)
|
627
|
+
* * *
|
628
|
+
|
629
|
+
** APIs updated**:
|
630
|
+
A new reason code 'Subscription cancellation' has been added to the Credit note resource.
|
631
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_attributes
|
632
|
+
|
633
|
+
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.
|
634
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
635
|
+
|
636
|
+
A new attribute 'next_billing_at' has been added to the Subscription resource.
|
637
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
638
|
+
|
639
|
+
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.
|
640
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#update_a_subscription
|
641
|
+
|
642
|
+
The input parameter 'reactivate_from' has been added to Reactivate a subscription API.
|
643
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#reactivate_a_subscription
|
644
|
+
|
645
|
+
** APIs added**:
|
646
|
+
A new endpoint 'Charge Future Renewals' has been added to the Subscription API.
|
647
|
+
https://apidocs.chargebee.com/docs/api/subscriptions#charge_future_renewals
|
648
|
+
|
649
|
+
### v2.2.3 (2017-01-27)
|
650
|
+
* * *
|
651
|
+
|
652
|
+
** APIs updated**:
|
653
|
+
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.
|
654
|
+
See: https://apidocs.chargebee.com/docs/api/cards
|
655
|
+
|
656
|
+
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.
|
657
|
+
See: https://apidocs.chargebee.com/docs/api/customers
|
658
|
+
|
659
|
+
A input param 'fraud_flag' has been added to Update customer API.
|
660
|
+
See: https://apidocs.chargebee.com/docs/api/customers#update_a_customer
|
661
|
+
|
662
|
+
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.
|
663
|
+
See: https://apidocs.chargebee.com/docs/api/cards#update_card_for_a_customer
|
664
|
+
|
665
|
+
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.
|
666
|
+
See: https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
|
667
|
+
|
668
|
+
A new input params 'billing_address' and 'shipping_address' has been added to Checkout new hosted page API.
|
669
|
+
See: https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
|
670
|
+
|
671
|
+
** APIs added**:
|
672
|
+
A new endpoint Create subscription for a customer estimate has been added to the Estimate resource.
|
673
|
+
See: https://apidocs.chargebee.com/docs/api/estimates#create_subscription_for_a_customer_estimate
|
674
|
+
|
675
|
+
|
676
|
+
### v2.2.2 (2017-01-12)
|
677
|
+
* * *
|
678
|
+
|
679
|
+
** APIs added**:
|
680
|
+
A new endpoint, Unarchive a plan has been added to the Plan resource.
|
681
|
+
See: https://apidocs.chargebee.com/docs/api/plans#unarchive_a_plan
|
682
|
+
|
683
|
+
A new endpoint, Unarchive an addon has been added to the Addon resource.
|
684
|
+
See : https://apidocs.chargebee.com/docs/api/addons#unarchive_an_addon
|
685
|
+
|
686
|
+
A new endpoint, Unarchive a coupon has been added to the Coupon resource.
|
687
|
+
See : https://apidocs.chargebee.com/docs/api/coupons#unarchive_a_coupon
|
688
|
+
|
689
|
+
### v2.2.1 (2016-12-30)
|
690
|
+
* * *
|
691
|
+
|
692
|
+
** APIs updated**:
|
693
|
+
|
694
|
+
The attributes 'plan_unit_price', 'setup_fee', 'billing_period', 'billing_period_unit' and 'plan_free_quantity' has been added to the Subscription resource.
|
695
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
696
|
+
|
697
|
+
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.
|
698
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription
|
699
|
+
|
700
|
+
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.
|
701
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#create_an_invoice
|
702
|
+
|
703
|
+
An attribute 'tax_exempt_reason' has been added to line items sub resource in Invoice, Credit Note and Estimate resources.
|
704
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
705
|
+
|
706
|
+
### v2.2.0 (2016-12-09)
|
707
|
+
* * *
|
708
|
+
|
709
|
+
** APIs updated**:
|
710
|
+
A new attribute, 'locale' has been added to the Customer resource.
|
711
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
712
|
+
|
713
|
+
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.
|
714
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
715
|
+
|
716
|
+
The attributes 'mrr', 'exchange_rate' and 'base_currency_code' have been added to the Subscription resource.
|
717
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
718
|
+
|
719
|
+
A new filter parameter 'cancelled_at' has been added to List Subscription API.
|
720
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#list_subscriptions
|
721
|
+
|
722
|
+
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.
|
723
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
724
|
+
|
725
|
+
The attributes 'sku', 'accounting_code', 'accounting_category1' and 'accounting_category2' have been added to the Plan and the Addon resource.
|
726
|
+
See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
727
|
+
|
728
|
+
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.
|
729
|
+
See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
|
730
|
+
|
731
|
+
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.
|
732
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#record_an_invoice_payment
|
733
|
+
|
734
|
+
### v2.1.9 (2016-11-24)
|
735
|
+
* * *
|
736
|
+
|
737
|
+
** APIs updated**:
|
738
|
+
A new attribute, 'funding_type' has been added to Card resource.
|
739
|
+
See : https://apidocs.chargebee.com/docs/api/cards#card_attributes
|
740
|
+
|
741
|
+
** APIs added**:
|
742
|
+
A new endpoint, List coupon codes API has been added to Coupon Code resource.
|
743
|
+
See : https://apidocs.chargebee.com/docs/api/coupon_codes#list_coupon_codes
|
744
|
+
|
745
|
+
A new endpoint, Copy a plan API has been added to Plan resource.
|
746
|
+
See : https://apidocs.chargebee.com/docs/api/plans#copy_a_plan
|
747
|
+
|
748
|
+
A new endpoint, Copy an addon API has been added to Addon resource.
|
749
|
+
See : https://apidocs.chargebee.com/docs/api/addons#copy_an_addon
|
750
|
+
|
751
|
+
A new endpoint, Copy a coupon API has been added to Coupon resource.
|
752
|
+
See : https://apidocs.chargebee.com/docs/api/coupons#copy_a_coupon
|
753
|
+
|
754
|
+
A new endpoint, Import a subscription API has been added to Subscription resource.
|
755
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#import_a_subscription
|
756
|
+
|
757
|
+
A new endpoint, Import Subscription for customer API has been added to Subscription resource.
|
758
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#import_subscription_for_customer
|
759
|
+
|
760
|
+
A new endpoint, Import invoice API has been added to Invoice resource.
|
761
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#import_invoice
|
762
|
+
|
763
|
+
|
764
|
+
### v2.1.8 (2016-11-18)
|
765
|
+
* * *
|
766
|
+
|
767
|
+
** APIs updated**:
|
768
|
+
A new attribute, 'tax_profile_id' has been added to Addon and Plan resource.
|
769
|
+
See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
770
|
+
|
771
|
+
The new input parameter 'tax_profile_id' has been added in Create and Update Addon and Plan APIs.
|
772
|
+
See : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
|
773
|
+
|
774
|
+
The new cancel reason type 'non_compliant_customer' has been added to the Subscription resource.
|
775
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
776
|
+
|
777
|
+
### v2.1.7 (2016-11-09)
|
778
|
+
* * *
|
779
|
+
|
780
|
+
** APIs updated**:
|
781
|
+
The attributes "updated_at" and "resource_version" is added to Plan, Addon and Coupon resource.
|
782
|
+
See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
783
|
+
|
784
|
+
Following [Event types](https://apidocs.chargebee.com/docs/api/events#event_types) are added
|
785
|
+
* *plan_created*
|
786
|
+
* *plan_updated*
|
787
|
+
* *plan_deleted*
|
788
|
+
* *addon_created*
|
789
|
+
* *addon_updated*
|
790
|
+
* *addon_deleted*
|
791
|
+
* *coupon_created*
|
792
|
+
* *coupon_updated*
|
793
|
+
* *coupon_deleted*
|
794
|
+
* *netd_payment_due_reminder*
|
795
|
+
|
796
|
+
The new Invoice status "posted" is added.
|
797
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
798
|
+
|
799
|
+
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
|
800
|
+
|
801
|
+
The input parameter "net_term_days" is added to Create a Subscription API. See : https://apidocs.chargebee.com/docs/api/subscriptions#create_a_subscription
|
802
|
+
|
803
|
+
The attributes "net_term_days" and "due_date" is added to the Invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices
|
804
|
+
|
805
|
+
|
806
|
+
### v2.1.6 (2016-10-27)
|
807
|
+
* * *
|
808
|
+
|
809
|
+
** APIs updated**:
|
810
|
+
|
811
|
+
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.
|
812
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
813
|
+
|
814
|
+
### v2.1.5 (2016-09-30)
|
815
|
+
* * *
|
816
|
+
|
817
|
+
** APIs updated**:
|
818
|
+
The new attributes "updated_at", "resource_version" and "deleted" is returned as part of Customer, Subscription, Invoice, Credit Note and Transaction resources.
|
819
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
820
|
+
|
821
|
+
The new parameter "include_deleted" is added to Customer, Subscription, Invoice, Credit Note and Transaction List API.
|
822
|
+
See : https://apidocs.chargebee.com/docs/api/customers#list_customers
|
823
|
+
|
824
|
+
The new parameter "date" is added to Create Credit Note API.
|
825
|
+
See : https://apidocs.chargebee.com/docs/api/credit_notes#create_credit_note
|
826
|
+
|
827
|
+
### v2.1.4 (2016-09-21)
|
828
|
+
* * *
|
829
|
+
|
830
|
+
[Pull Request](https://github.com/chargebee/chargebee-ruby/pull/7) have been merged.
|
831
|
+
|
832
|
+
** APIs updated**:
|
833
|
+
The new Gateway type "gocardless" for card resource is added. See card attributes
|
834
|
+
See : https://apidocs.chargebee.com/docs/api/cards#card_attributes
|
835
|
+
|
836
|
+
### v2.1.3 (2016-09-03)
|
837
|
+
* * *
|
838
|
+
** APIs added**:
|
839
|
+
A new endpoint to create Credit Note is added. See : https://apidocs.chargebee.com/docs/api/credit_notes#create_credit_note
|
840
|
+
|
841
|
+
A new endpoint to write off Invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#write_off_an_invoice
|
842
|
+
|
843
|
+
** APIs updated**:
|
844
|
+
The attribute "forward_url" is given as input for Create a Portal Session API.
|
845
|
+
See : https://apidocs.chargebee.com/docs/api/portal_sessions#create_a_portal_session
|
846
|
+
|
847
|
+
### v2.1.2 (2016-08-25)
|
848
|
+
* * *
|
849
|
+
|
850
|
+
** APIs updated**:
|
851
|
+
The attribute "validation_status" is added to address.
|
852
|
+
See : https://apidocs.chargebee.com/docs/api/addresses#address_attributes
|
853
|
+
|
854
|
+
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.
|
855
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
856
|
+
|
857
|
+
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.
|
858
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
859
|
+
|
860
|
+
The attribute "validation_status" is returned as part of Invoice billing and shipping address.
|
861
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
862
|
+
|
863
|
+
The sub resource "shipping_address" is now returned as part of Subscription Estimate in Estimate APIs.
|
864
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
865
|
+
|
866
|
+
The attribute "created_from_ip", "card_ip_address" is deprecated from Customer and Subscription resource.
|
867
|
+
See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
868
|
+
|
869
|
+
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.
|
870
|
+
See : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
871
|
+
|
872
|
+
The status "pending_verification" added to Payment Method status.
|
873
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
874
|
+
|
875
|
+
|
876
|
+
### v2.1.1 (2016-08-02)
|
877
|
+
* * *
|
878
|
+
** APIs added**:
|
879
|
+
A new endpoint to retrieve Credit Note as PDF. See : https://apidocs.chargebee.com/docs/api/credit_notes#retrieve_credit_note_as_pdf
|
880
|
+
|
881
|
+
** APIs updated**:
|
882
|
+
The attribute "invoice notes" is added to subscription in Hosted Pages Checkout New and Checkout Existing API's.
|
883
|
+
See : https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
|
884
|
+
|
885
|
+
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
|
886
|
+
|
887
|
+
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
|
888
|
+
|
889
|
+
### v2.1.0 (2016-07-18)
|
890
|
+
* * *
|
891
|
+
** APIs added**:
|
892
|
+
A new endpoint to remove coupons associated with the subscription is added. See : https://apidocs.chargebee.com/docs/api/subscriptions#remove_coupons
|
893
|
+
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
|
894
|
+
|
895
|
+
### v2.0.9 (2016-07-06)
|
896
|
+
* * *
|
897
|
+
** APIs added**:
|
898
|
+
A new endpoint to delete a coupon added. See : https://apidocs.chargebee.com/docs/api/coupons#delete_a_coupon
|
899
|
+
|
900
|
+
### v2.0.8 (2016-07-04)
|
901
|
+
* * *
|
902
|
+
** APIs updated**:
|
903
|
+
The attribute "currency_code" is added as part of Plans, Addons, Coupons, Subscription, Transaction and Estimate resource.
|
904
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
905
|
+
|
906
|
+
The API's Set promotional credits for a customer, Add promotional credits to a customer and Deduct promotional credits for a customer takes in "currency_code" as input.
|
907
|
+
See : https://apidocs.chargebee.com/docs/api/customers#set_promotional_credits_for_a_customer
|
908
|
+
|
909
|
+
### v2.0.7 (2016-06-27)
|
910
|
+
* * *
|
911
|
+
|
912
|
+
** APIs updated**:
|
913
|
+
New resource "third_party_payment_method" is returned on performing copy card for a customer API.
|
914
|
+
See : https://apidocs.chargebee.com/docs/api/cards#copy_card
|
915
|
+
|
916
|
+
### v2.0.6 (2016-06-16)
|
917
|
+
* * *
|
918
|
+
|
919
|
+
** APIs updated**:
|
920
|
+
New subresource "next_invoice_estimate" is returned as part of Estimate resource.
|
921
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
922
|
+
|
923
|
+
### v2.0.5 (2016-05-24)
|
924
|
+
* * *
|
925
|
+
|
926
|
+
** APIs updated**:
|
927
|
+
|
928
|
+
New attribute "currency_code" is returned as part of Credit Note resource.
|
929
|
+
See: https://apidocs.chargebee.com/docs/api/credit_notes#credit_note_attributes
|
930
|
+
|
931
|
+
The new Gateway type "wepay" for card resource is added. See subscription attributes
|
932
|
+
See : https://apidocs.chargebee.com/docs/api/cards#card_attributes
|
933
|
+
|
934
|
+
### v2.0.4 (2016-05-20)
|
935
|
+
* * *
|
936
|
+
|
937
|
+
Removed unwanted file.
|
938
|
+
|
939
|
+
### v2.0.3 (2016-05-20)
|
940
|
+
* * *
|
941
|
+
|
942
|
+
#### Filtering Resources using List API
|
943
|
+
|
944
|
+
Chargebee supports bulk fetching of resources via 'List' API methods. (List invoices, List subscriptions etc..). In the List methods, filtering of resources can be performed using filter parameters. Also in the List methods, the sort_by parameter is provided for sorting the result in the desired order.
|
945
|
+
See : https://apidocs.chargebee.com/docs/api#pagination_and_filtering
|
946
|
+
|
947
|
+
** APIs deprecated**:
|
948
|
+
|
949
|
+
The Following API's are deprecated since these operations can be achieved through List API's
|
950
|
+
* List Subscriptions for a Customer
|
951
|
+
* List Invoices for a Customer
|
952
|
+
* List Invoices for a Subscription
|
953
|
+
* List Credit Note for a Customer
|
954
|
+
* List Credit Note for a Subscription
|
955
|
+
* List Transactions for a Customer
|
956
|
+
* List Transations for a Subscription
|
957
|
+
|
958
|
+
** APIs added**:
|
959
|
+
|
960
|
+
Support to copy card to gateway for a customer. New api endpoint to copy card for a customer is added to Card resources.
|
961
|
+
See: https://apidocs.chargebee.com/docs/api/cards#copy_card
|
962
|
+
|
963
|
+
** APIs updated**:
|
964
|
+
|
965
|
+
New attribute "id" is returned as part of Line Items subresource of Invoice and Credit Note resource.
|
966
|
+
See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
967
|
+
|
968
|
+
New attribute "name" is returned as part of Taxes subresource of Invoice and Credit Note resource.
|
969
|
+
See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
970
|
+
|
971
|
+
|
972
|
+
A new sub-resource "line_item_taxes" is returned as part of the Invoice and Credit Note resource attributes.
|
973
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
974
|
+
|
975
|
+
|
976
|
+
### v2.0.2 (2016-05-02)
|
977
|
+
* * *
|
978
|
+
** APIs added**:
|
979
|
+
|
980
|
+
Support to archive a coupon code. See archive Coupon code API here: https://apidocs.chargebee.com/docs/api/coupon_codes#archive_a_coupon_code
|
981
|
+
|
982
|
+
** APIs updated**:
|
983
|
+
|
984
|
+
The attribute for "status" is returned as part of Coupon Code resource. See : https://apidocs.chargebee.com/docs/api/coupon_codes#coupon_code_attributes
|
985
|
+
|
986
|
+
### v2.0.1 (2016-04-29)
|
987
|
+
* * *
|
988
|
+
|
989
|
+
** APIs updated**
|
990
|
+
|
991
|
+
Support to specify Avalara "tax_code" attribute in Plan and Addon resource. Now, create and update plan, create & update addon accept "tax_code" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
|
992
|
+
|
993
|
+
Support to specify the exemption category or exempt number for a customer by adding "entity_code" or "exempt_number" in customer resource. You can pass "entity_code" and "exempt_number" in create, update customer, create subscription and create subscription estimate APIs. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
994
|
+
|
995
|
+
The attribute "entity_code" or "exempt_number" is returned as part of Customer resource for Avalara.
|
996
|
+
See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
997
|
+
|
998
|
+
The attribute "tax_code" is returned as part of Plan & Addon resources for Avalara.
|
999
|
+
See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
1000
|
+
|
1001
|
+
Support for address parameters in estimate APIs that is used to calculate tax. Now, create & update subscription estimate APIs accept line1, line2, line3 and city. See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
1002
|
+
|
1003
|
+
The new Cancel reason type "tax_calculation_failed" for subscription resource is added. See subscription attributes
|
1004
|
+
See : https://apidocs.chargebee.com/docs/api/subscriptions#subscription_attributes
|
1005
|
+
|
1006
|
+
** APIs deprecated**:
|
1007
|
+
|
1008
|
+
The attribute "taxability" for customer has been deprecated in the Update Subscription Estimate API.
|
1009
|
+
|
1010
|
+
### v2.0.0 (2016-04-11)
|
1011
|
+
* * *
|
1012
|
+
|
1013
|
+
#### Attributes and Operations Removed/Renamed in V2
|
1014
|
+
Chargebee [API V2](https://apidocs.chargebee.com/docs/api#versions) is now live! All our future developments will happen in V2.
|
1015
|
+
|
1016
|
+
V2 has been released to accommodate certain backwards-incompatible changes. Refer our [API V2 Upgradation guide](https://apidocs.chargebee.com/docs/api/v1#api-v2-upgradation-guide) for the complete listing of the attributes and operations that have been removed/renamed in API V2.
|
1017
|
+
|
1018
|
+
#### Incremental Changes in V2
|
1019
|
+
|
1020
|
+
* *api_version* attribute is added to [Event](https://apidocs.chargebee.com/docs/api/events) resource. More details [here](#v1176-2016-04-06).
|
1021
|
+
* Credit Notes resource is introduced. More details here: https://apidocs.chargebee.com/docs/api/credit_notes
|
1022
|
+
* 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).
|
1023
|
+
* 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*.
|
1024
|
+
* Following attributes are added to [invoice](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) resource
|
1025
|
+
* *write_off_amount*
|
1026
|
+
* *applied_credits[]* - the Refundable Credits applied to this invoice.
|
1027
|
+
* *adjustment_credit_notes[]* - The Adjustment Credit Notes created for this invoice.
|
1028
|
+
* *issued_credit_notes[]* - The Refundable Credit Notes created against this invoice.
|
1029
|
+
* For 'Refund' type [transaction](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes), *linked_credit_notes[]* will be returned.
|
1030
|
+
* Following [Event types](https://apidocs.chargebee.com/docs/api/events#event_types) are added
|
1031
|
+
* *credit_note_created*
|
1032
|
+
* *credit_note_updated*
|
1033
|
+
* *credit_note_deleted*
|
1034
|
+
* Following attributes are added to [line_items[]](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) sub-resource:
|
1035
|
+
* *discount_amount* - the total discount amount (both item-level and document-level discounts) of this line.
|
1036
|
+
* *item_level_discount_amount* - only the item-level-discount amount component.
|
1037
|
+
* 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*.
|
1038
|
+
* 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)
|
1039
|
+
* The API's *checkout_onetime_addons* and *checkout_onetime_charge* in Hosted Page resource are removed in V2.
|
24
1040
|
|
25
1041
|
### v1.7.2 (2016-04-06)
|
26
1042
|
* * *
|
@@ -28,7 +1044,7 @@
|
|
28
1044
|
*api_version* attribute is added to the Event resource.
|
29
1045
|
|
30
1046
|
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:
|
31
|
-
https://apidocs.chargebee.com/docs/api/
|
1047
|
+
https://apidocs.chargebee.com/docs/api/events
|
32
1048
|
|
33
1049
|
### v1.7.1 (2016-03-22)
|
34
1050
|
* * *
|
@@ -36,26 +1052,26 @@ https://apidocs.chargebee.com/docs/api/v1/events
|
|
36
1052
|
** APIs updated**:
|
37
1053
|
|
38
1054
|
Support to specify additional information as "meta_data" in json format for Customer, Subscription, Plan, Addon & Coupon resources.
|
39
|
-
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/
|
1055
|
+
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
|
40
1056
|
|
41
|
-
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/
|
1057
|
+
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
|
42
1058
|
|
43
1059
|
|
44
1060
|
** APIs added**:
|
45
1061
|
|
46
|
-
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/
|
1062
|
+
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
|
47
1063
|
|
48
1064
|
|
49
1065
|
** Issue Fixed**:
|
50
1066
|
|
51
|
-
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/
|
1067
|
+
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
|
52
1068
|
|
53
1069
|
### v1.7.0 (2016-03-10)
|
54
1070
|
* * *
|
55
1071
|
|
56
1072
|
** APIs updated**:
|
57
1073
|
|
58
|
-
Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/
|
1074
|
+
Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
|
59
1075
|
|
60
1076
|
Typo fix in chargebee.gemspec file.
|
61
1077
|
|
@@ -68,16 +1084,16 @@ RSpec development dependancy version has been upgraded to 3.0.0
|
|
68
1084
|
|
69
1085
|
Support to delete a subscription. See: https://www.chargebee.com/docs/subscriptions.html#deleting-a-subscription
|
70
1086
|
New api endpoint to delete 'Subscription' is added to Subscription resources. See delete subscription API here:
|
71
|
-
https://apidocs.chargebee.com/docs/api/
|
1087
|
+
https://apidocs.chargebee.com/docs/api/subscriptions#delete_a_subscription
|
72
1088
|
|
73
1089
|
Support to delete a customer. See: https://www.chargebee.com/docs/customers.html#deleting-a-customer
|
74
1090
|
New api endpoint to delete 'Customer' is added to Customer resources. See delete customer API here:
|
75
|
-
https://apidocs.chargebee.com/docs/api/
|
1091
|
+
https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
|
76
1092
|
|
77
1093
|
|
78
1094
|
** APIs updated**:
|
79
1095
|
|
80
|
-
Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/
|
1096
|
+
Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
|
81
1097
|
|
82
1098
|
### v1.6.8 (2016-02-08)
|
83
1099
|
* * *
|
@@ -85,22 +1101,22 @@ Now, events "subscription_deleted" & "customer_deleted" can be fetched via API.
|
|
85
1101
|
** APIs added**:
|
86
1102
|
|
87
1103
|
Support to add additional contact for a customer. See: https://www.chargebee.com/docs/customers.html#add-contact
|
88
|
-
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/
|
1104
|
+
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
|
89
1105
|
|
90
1106
|
** APIs updated**:
|
91
1107
|
|
92
|
-
New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/
|
1108
|
+
New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
93
1109
|
|
94
|
-
Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/
|
1110
|
+
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
|
95
1111
|
|
96
1112
|
New attribute 'refundable_credits' is returned as part of Customer resource.
|
97
1113
|
|
98
|
-
New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/
|
1114
|
+
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
|
99
1115
|
|
100
|
-
New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/
|
1116
|
+
New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
101
1117
|
|
102
1118
|
New entity type 'credit_note' is added as part of 'entity_type' attribute of Comment resource.
|
103
|
-
See: https://apidocs.chargebee.com/docs/api/
|
1119
|
+
See: https://apidocs.chargebee.com/docs/api/comments#comment_attributes
|
104
1120
|
|
105
1121
|
### v1.6.7 (2015-12-15)
|
106
1122
|
* * *
|
@@ -114,10 +1130,10 @@ Wrong API invocation issue if empty/null value passed instead of resource id, is
|
|
114
1130
|
|
115
1131
|
** APIs updated**:
|
116
1132
|
|
117
|
-
Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/
|
1133
|
+
Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
|
118
1134
|
|
119
1135
|
New attribute "enabled_in_portal" is returned as part of Plan/Addon resource.
|
120
|
-
See plan attributes here: https://apidocs.chargebee.com/docs/api/
|
1136
|
+
See plan attributes here: https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
121
1137
|
|
122
1138
|
### v1.6.5 (2015-11-09)
|
123
1139
|
* * *
|
@@ -127,57 +1143,57 @@ See plan attributes here: https://apidocs.chargebee.com/docs/api/v1/plans#plan_a
|
|
127
1143
|
Support for excess payments. See : https://www.chargebee.com/docs/customers.html#excess-payments
|
128
1144
|
|
129
1145
|
New attribute "excess_payments" is returned as part of Customer resource.
|
130
|
-
See: https://apidocs.chargebee.com/docs/api/
|
1146
|
+
See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
131
1147
|
|
132
1148
|
New attribute "applied_at" is returned as part of Linked Transaction subresource of Invoice resource.
|
133
|
-
See: https://apidocs.chargebee.com/docs/api/
|
1149
|
+
See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
134
1150
|
|
135
1151
|
New transaction type "PAYMENT_REVERSAL" is returned as part of Transaction resource.
|
136
|
-
See: https://apidocs.chargebee.com/docs/api/
|
1152
|
+
See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
137
1153
|
|
138
1154
|
New attributes "amount_unused", "reference_transaction_id", "reversal_transaction_id" & "linked_refunds" subresource are returned as part of Transaction resource.
|
139
1155
|
|
140
1156
|
New attribute "applied_at" is returmed as part of Linked Invoice subresource of Transaction resource.
|
141
|
-
See: https://apidocs.chargebee.com/docs/api/
|
1157
|
+
See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
142
1158
|
|
143
1159
|
### v1.6.4 (2015-10-26)
|
144
1160
|
* * *
|
145
1161
|
|
146
1162
|
** APIs updated**:
|
147
1163
|
|
148
|
-
Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/
|
1164
|
+
Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
149
1165
|
|
150
1166
|
New attribute "allow_direct_debit" is returned as part of Customer resource.
|
151
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1167
|
+
See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
152
1168
|
|
153
1169
|
New "price_type" attribute is returned as part of Estimate & Invoice Resource.
|
154
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1170
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
155
1171
|
|
156
1172
|
Support for address parameters in estimate APIs that is used to calculate tax. Now, create & update subscription estimate APIs accept billing state code, billing zip, shipping country, shipping state code & shipping zip.
|
157
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1173
|
+
See : https://apidocs.chargebee.com/docs/api/estimates#create_subscription_estimate
|
158
1174
|
|
159
1175
|
### v1.6.3 (2015-09-18)
|
160
1176
|
* * *
|
161
1177
|
|
162
1178
|
** APIs updated**:
|
163
1179
|
|
164
|
-
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/
|
1180
|
+
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
|
165
1181
|
|
166
|
-
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/
|
1182
|
+
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
|
167
1183
|
|
168
1184
|
The attribute "taxablility" is returned as part of Customer resource.
|
169
|
-
https://apidocs.chargebee.com/docs/api/
|
1185
|
+
https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
170
1186
|
|
171
1187
|
The attribute "taxable" is returned as part of Plan resource.
|
172
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1188
|
+
See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
|
173
1189
|
|
174
1190
|
The attribute "taxable" is returned as part of Addon resource.
|
175
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1191
|
+
See : https://apidocs.chargebee.com/docs/api/addons#addon_attributes
|
176
1192
|
|
177
1193
|
|
178
1194
|
The attribute "is_taxed" returned as part of "line_items" subresource of Estimate & Invoice resorces.
|
179
1195
|
See attribute of line_items in Estimate here :
|
180
|
-
https://apidocs.chargebee.com/docs/api/
|
1196
|
+
https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
|
181
1197
|
|
182
1198
|
### v1.6.2 (2015-09-07)
|
183
1199
|
* * *
|
@@ -185,10 +1201,10 @@ https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
|
|
185
1201
|
** APIs updated**:
|
186
1202
|
|
187
1203
|
The attribute for "user" is returned as part of Event resource.
|
188
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1204
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_attributes
|
189
1205
|
|
190
1206
|
Support for multiple webhooks. The attribute "webhooks" contains list of Webhook subresource is returned as part of Event API.
|
191
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1207
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_attributes
|
192
1208
|
|
193
1209
|
** APIs deprecated**:
|
194
1210
|
|
@@ -200,40 +1216,40 @@ Attributes "webhook_status" & "webhook_failure_reason" of event resource has bee
|
|
200
1216
|
** APIs updated**:
|
201
1217
|
|
202
1218
|
The attribute for "first_invoice" & "currency_code" is returned as part of Invoice resource.
|
203
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1219
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
204
1220
|
|
205
1221
|
The attribute for "currency_code" is returned as part of Transaction resource.
|
206
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1222
|
+
See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
|
207
1223
|
|
208
1224
|
A new source type "bulk_operation" is returned as part of "source" attribute of event resource.
|
209
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1225
|
+
See : https://apidocs.chargebee.com/docs/api/events#event_attributes
|
210
1226
|
|
211
1227
|
### v1.6.0 (2015-07-20)
|
212
1228
|
* * *
|
213
1229
|
|
214
1230
|
** APIs added**:
|
215
1231
|
|
216
|
-
New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/
|
1232
|
+
New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/invoices#stop_dunning_for_invoice
|
217
1233
|
|
218
1234
|
** APIs updated**:
|
219
1235
|
|
220
1236
|
The attribute for "dunning_status" is returned as part of Invoice resource.
|
221
|
-
See : https://apidocs.chargebee.com/docs/api/
|
1237
|
+
See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
222
1238
|
|
223
1239
|
### v1.5.9 (2015-07-09)
|
224
1240
|
* * *
|
225
1241
|
|
226
1242
|
** APIs added**:
|
227
1243
|
|
228
|
-
New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/
|
1244
|
+
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
|
229
1245
|
|
230
1246
|
** APIs updated**:
|
231
1247
|
|
232
|
-
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/
|
1248
|
+
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
|
233
1249
|
|
234
|
-
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/
|
1250
|
+
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
|
235
1251
|
|
236
|
-
A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/
|
1252
|
+
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
|
237
1253
|
|
238
1254
|
A new discount type "account_credits" is added as part of "type" attribute of discounts sub-resource for estimate resource.
|
239
1255
|
|
@@ -246,34 +1262,34 @@ Attributes "description" & "void_description" of transaction resource has been d
|
|
246
1262
|
|
247
1263
|
** APIs added**:
|
248
1264
|
|
249
|
-
New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/
|
1265
|
+
New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#void_an_invoice
|
250
1266
|
|
251
1267
|
** APIs updated**:
|
252
1268
|
|
253
|
-
A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/
|
1269
|
+
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
|
254
1270
|
|
255
1271
|
** APIs deprecated**:
|
256
1272
|
|
257
|
-
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/
|
1273
|
+
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
|
258
1274
|
|
259
1275
|
### v1.5.7 (2015-06-12)
|
260
1276
|
* * *
|
261
1277
|
|
262
1278
|
** APIs added**:
|
263
1279
|
|
264
|
-
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/
|
265
|
-
https://apidocs.chargebee.com/docs/api/
|
266
|
-
https://apidocs.chargebee.com/docs/api/
|
1280
|
+
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
|
1281
|
+
https://apidocs.chargebee.com/docs/api/customers#deduct_account_credits_for_a_customer
|
1282
|
+
https://apidocs.chargebee.com/docs/api/customers#set_account_credits_for_a_customer
|
267
1283
|
|
268
1284
|
** APIs updated**:
|
269
1285
|
|
270
|
-
Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/
|
1286
|
+
Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
|
271
1287
|
|
272
|
-
A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/
|
1288
|
+
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
|
273
1289
|
|
274
|
-
The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/
|
1290
|
+
The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
|
275
1291
|
|
276
|
-
A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/
|
1292
|
+
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
|
277
1293
|
|
278
1294
|
** APIs deprecated**:
|
279
1295
|
|
@@ -288,9 +1304,9 @@ The attribute "discount_quantity" deprecated for Create method of Coupon API.
|
|
288
1304
|
|
289
1305
|
** APIs added**:
|
290
1306
|
|
291
|
-
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/
|
1307
|
+
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.
|
292
1308
|
|
293
|
-
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/
|
1309
|
+
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.
|
294
1310
|
|
295
1311
|
** APIs updated**:
|
296
1312
|
|
@@ -309,15 +1325,15 @@ The resource attribute for "po_number" is returned as part of Subscription and I
|
|
309
1325
|
Create and Update methods of plan, addon, coupon, customer and subscripiton APIs now accept "invoice_notes" that is added to the invoice raised for a customer. Read more about invoice notes : https://www.chargebee.com/docs/invoice_notes.html
|
310
1326
|
|
311
1327
|
A new sub-resource "notes" is returned as part of the Invoice resource attributes.
|
312
|
-
See https://apidocs.chargebee.com/docs/api/
|
1328
|
+
See https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
|
313
1329
|
|
314
1330
|
A new attribute "amount_due" is returned as part of Invoice resource.
|
315
1331
|
|
316
1332
|
Checkout new, checkout existing, update payment method method APIs now accept "redirect_url" & "cancel_url" to which your customer should be redirected.
|
317
|
-
See https://apidocs.chargebee.com/docs/api/
|
1333
|
+
See https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
|
318
1334
|
|
319
1335
|
Now, event "subscription_renewal_reminder" can be fetched via API.
|
320
|
-
See https://apidocs.chargebee.com/docs/api/
|
1336
|
+
See https://apidocs.chargebee.com/docs/api/events#event_types.
|
321
1337
|
|
322
1338
|
### v1.5.4 (2015-03-30)
|
323
1339
|
* * *
|
@@ -325,27 +1341,27 @@ See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
|
|
325
1341
|
** APIs added**:
|
326
1342
|
|
327
1343
|
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.
|
328
|
-
See https://apidocs.chargebee.com/docs/api/
|
1344
|
+
See https://apidocs.chargebee.com/docs/api/invoices#delete_an_invoice.
|
329
1345
|
|
330
1346
|
** APIs updated**:
|
331
1347
|
|
332
1348
|
Create subscription/customer, update subscription/payment method APIs now accepts the IP Address of customer for card resource.
|
333
1349
|
|
334
1350
|
Now, event "invoice_deleted" can be fetched via API.
|
335
|
-
See https://apidocs.chargebee.com/docs/api/
|
1351
|
+
See https://apidocs.chargebee.com/docs/api/events#event_types.
|
336
1352
|
|
337
1353
|
### v1.5.3 (2015-02-27)
|
338
1354
|
* * *
|
339
1355
|
|
340
1356
|
** APIs added**:
|
341
1357
|
|
342
|
-
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/
|
1358
|
+
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.
|
343
1359
|
|
344
|
-
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/
|
1360
|
+
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.
|
345
1361
|
|
346
1362
|
** APIs updated**:
|
347
1363
|
|
348
|
-
Shipping and Billing Address are returned as part of Invoice resource attributes. This returns the
|
1364
|
+
Shipping and Billing Address are returned as part of Invoice resource attributes. This returns the shipping & billing address that was present at the time of invoice generation.
|
349
1365
|
|
350
1366
|
Linked Customers as part of Portal session resource attributes.
|
351
1367
|
|
@@ -367,7 +1383,7 @@ Create subscription/customer, update subscription/customer/payment method/billin
|
|
367
1383
|
Support for PayPal & Amazon payment added.
|
368
1384
|
|
369
1385
|
** APIs added**:
|
370
|
-
A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/
|
1386
|
+
A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method for details.
|
371
1387
|
|
372
1388
|
** APIs deprecated**:
|
373
1389
|
Update card(HostedPage) API is deprecated as an alternate API is added.
|
@@ -380,10 +1396,10 @@ Create a customer API now accepts the end user IP.
|
|
380
1396
|
|
381
1397
|
**APIs added**:
|
382
1398
|
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.
|
383
|
-
See https://apidocs.chargebee.com/docs/api/
|
1399
|
+
See https://apidocs.chargebee.com/docs/api/orders?lang=ruby for details.
|
384
1400
|
|
385
1401
|
**API Updates**:
|
386
|
-
Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/
|
1402
|
+
Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices.
|
387
1403
|
|
388
1404
|
### v1.4.9 (2014-11-24)
|
389
1405
|
* * *
|
@@ -401,7 +1417,7 @@ Bug fixes.
|
|
401
1417
|
* * *
|
402
1418
|
|
403
1419
|
**APIs Updated**:
|
404
|
-
* Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/
|
1420
|
+
* Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/customers#update_a_customer.
|
405
1421
|
|
406
1422
|
### v1.4.6 (2014-09-16)
|
407
1423
|
* * *
|
@@ -435,8 +1451,8 @@ Added properties:
|
|
435
1451
|
* Property has_scheduled_changes added to the Subscription resource to indicate whether there are any pending change scheduled for this Subscription
|
436
1452
|
|
437
1453
|
APIs added:
|
438
|
-
* Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/
|
439
|
-
* Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/
|
1454
|
+
* Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/subscriptions#retrieve_with_scheduled_changes.
|
1455
|
+
* Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/subscriptions#remove_scheduled_changes.
|
440
1456
|
|
441
1457
|
APIs updated:
|
442
1458
|
* Ability to pass description for Plans & Addons while Creating & Updating.
|
@@ -447,33 +1463,33 @@ APIs Removed:
|
|
447
1463
|
### v1.4.3 (2014-07-29)
|
448
1464
|
* * *
|
449
1465
|
APIs added:
|
450
|
-
* 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/
|
451
|
-
* 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/
|
452
|
-
*Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/
|
1466
|
+
* 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.
|
1467
|
+
* 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.
|
1468
|
+
*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
|
453
1469
|
|
454
1470
|
APIs updated:
|
455
|
-
* Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/
|
1471
|
+
* 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
|
456
1472
|
* Include delayed charges while calculating the Estimate.
|
457
1473
|
|
458
1474
|
### v1.4.2 (2014-06-19)
|
459
1475
|
* * *
|
460
1476
|
APIs added:
|
461
|
-
* Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/
|
462
|
-
* Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/
|
1477
|
+
* Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices_for_a_customer.
|
1478
|
+
* Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/transactions?lang=ruby#list_transactions_for_a_customer.
|
463
1479
|
|
464
1480
|
APIs updated:
|
465
|
-
* Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/
|
466
|
-
* Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/
|
1481
|
+
* 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=ruby#create_invoice_for_charge.
|
1482
|
+
* 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=ruby#create_invoice_for_addon.
|
467
1483
|
|
468
1484
|
### v1.4.1 (2014-05-28)
|
469
1485
|
* * *
|
470
|
-
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/
|
1486
|
+
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=ruby.
|
471
1487
|
|
472
1488
|
### v1.4.0 (2014-05-23)
|
473
1489
|
* * *
|
474
|
-
* New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/
|
1490
|
+
* New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/customers#create_a_customer
|
475
1491
|
|
476
|
-
* 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/
|
1492
|
+
* 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
|
477
1493
|
|
478
1494
|
* Customer id reference is added to the invoice attributes.
|
479
1495
|
|
@@ -483,15 +1499,15 @@ Support for returning shipping address as part of create/update subscription API
|
|
483
1499
|
|
484
1500
|
### v1.3.8 (2014-03-26)
|
485
1501
|
* * *
|
486
|
-
* Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/
|
1502
|
+
* Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices.
|
487
1503
|
|
488
|
-
* Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/
|
1504
|
+
* Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions.
|
489
1505
|
|
490
|
-
* 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/
|
1506
|
+
* 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")
|
491
1507
|
|
492
1508
|
### v1.3.7 (2014-03-18)
|
493
1509
|
* * *
|
494
|
-
Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/
|
1510
|
+
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").
|
495
1511
|
|
496
1512
|
### v1.3.6 (2014-03-10)
|
497
1513
|
* * *
|