chargebee 2.6.4 → 2.6.5

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