chargebee 1.7.5 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +111 -105
  3. data/README.rdoc +16 -14
  4. data/Rakefile +150 -150
  5. data/chargebee.gemspec +6 -3
  6. data/lib/chargebee.rb +5 -2
  7. data/lib/chargebee/environment.rb +1 -1
  8. data/lib/chargebee/list_result.rb +28 -28
  9. data/lib/chargebee/models/card.rb +2 -6
  10. data/lib/chargebee/models/credit_note.rb +44 -0
  11. data/lib/chargebee/models/credit_note_estimate.rb +23 -0
  12. data/lib/chargebee/models/customer.rb +7 -7
  13. data/lib/chargebee/models/estimate.rb +1 -15
  14. data/lib/chargebee/models/hosted_page.rb +0 -8
  15. data/lib/chargebee/models/invoice.rb +26 -10
  16. data/lib/chargebee/models/invoice_estimate.rb +23 -0
  17. data/lib/chargebee/models/model.rb +34 -3
  18. data/lib/chargebee/models/subscription_estimate.rb +10 -0
  19. data/lib/chargebee/models/transaction.rb +10 -10
  20. data/lib/chargebee/result.rb +75 -26
  21. data/lib/chargebee/util.rb +56 -56
  22. data/lib/ssl/ca-certs.crt +3385 -3385
  23. data/spec/chargebee/list_result_spec.rb +53 -53
  24. data/spec/chargebee_spec.rb +99 -99
  25. data/spec/sample_response.rb +1 -1
  26. data/spec/spec_helper.rb +24 -24
  27. metadata +6 -3
  28. data/lib/chargebee/models/payment_intent.rb +0 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0cdbb84e97810da089f28a80f9bf30b5fcf72b68
4
- data.tar.gz: 289eee525495e75501ad9d4caaf961f742f6ff51
3
+ metadata.gz: 7c2c9461edfffe9b8d8ba3b32fe9b3b19ac7ecef
4
+ data.tar.gz: c4747e382cac2a1f4fb374c1242c8212ad6347e2
5
5
  SHA512:
6
- metadata.gz: f2fcce06741815623c265e9a5d305805ce4637ab75eede6b8be1804532990a450905207d911756de7ee1d0eb1a122e1515b37d38e729a4571826662ea3160160
7
- data.tar.gz: 355fabbe04eddf1e464955d20009b3c60794852790d3b3b26f9949819915dd72e559741d5db6afd7405425f2eebf98cb19db103f5f635391d6e8f4747449121e
6
+ metadata.gz: ec971e6c965465068713a1f055760122a62cbe21c8c5dc816c8bbc4a55ff20e16b6d58e290cf852580e76df0ef51cdef01b38fbebd09e2c8618eeab1f6873114
7
+ data.tar.gz: b31b63c3c0ce34dcceb9ee8fd29bba0b4f46bf9f29d86b7ec4e243676fe3e4cf84179bc09a399916bc0dd17896b2a5e4a5674b6175968b49f136b35f94e58e99
data/CHANGELOG.md CHANGED
@@ -1,26 +1,32 @@
1
- ### v1.7.5(2019-08-27)
2
- * * *
3
-
4
- * New input parameter replace_primary_payment_source has been added in create_an_invoice api.
5
- * New input parameter payment_intent has been added in create_an_invoice and reactivate_a_subscription api.
6
- * New attribute currency_code has been added in payment_intent resource.
7
-
8
- ### v1.7.4(2019-08-14)
9
- * * *
10
-
11
- * New resource payment_intent has been added.
12
- * New input parameter 'id' in payment_intent sub-param has been added in update_card_for_customer_using_payment_intent, create_a_customer, create_a_subscription, create_subscription_for_customer, update_a_subscription.
13
- * New endpoints create_a_payment_intent, update_a_payment_intent and retrieve_a_payment_intent have been added.
14
-
15
- ### v1.7.3 (2019-07-22)
16
- * * *
17
-
18
- * New enpoint Update card for customer using payment intent has been added.
19
- * The attirbute reference_id has been added in card resource.
20
- * The input parameters payment_intent with gateway_account_id and gw_token have been added in create a customer, create subscription, create subscription for customer and update subscription API.
21
- * The attributes initiator_type and three_d_secure have been added in transaction resource.
22
- * New enpoint Update card for customer using payment intent has been added in card resource.
23
- * New attribute reference_id has been added in card resource.
1
+ ### v2.0.0 (2016-04-11)
2
+ * * *
3
+
4
+ #### Attributes and Operations Removed/Renamed in V2
5
+ Chargebee [API V2](https://apidocs.chargebee.com/docs/api#versions) is now live! All our future developments will happen in V2.
6
+
7
+ V2 has been released to accommodate certain backwards-incompatible changes. Refer our [API V2 Upgradation guide](https://apidocs.chargebee.com/docs/api#api-v2-upgradation-guide) for the complete listing of the attributes and operations that have been removed/renamed in API V2.
8
+
9
+ #### Incremental Changes in V2
10
+
11
+ * *api_version* attribute is added to [Event](https://apidocs.chargebee.com/docs/api/events) resource. More details [here](#v1176-2016-04-06).
12
+ * Credit Notes resource is introduced. More details here: https://apidocs.chargebee.com/docs/api/credit_notes
13
+ * 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).
14
+ * 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*.
15
+ * Following attributes are added to [invoice](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) resource
16
+ * *write_off_amount*
17
+ * *applied_credits[]* - the Refundable Credits applied to this invoice.
18
+ * *adjustment_credit_notes[]* - The Adjustment Credit Notes created for this invoice.
19
+ * *issued_credit_notes[]* - The Refundable Credit Notes created against this invoice.
20
+ * For 'Refund' type [transaction](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes), *linked_credit_notes[]* will be returned.
21
+ * Following [Event types](https://apidocs.chargebee.com/docs/api/events#event_types) are added
22
+ * *credit_note_created*
23
+ * *credit_note_updated*
24
+ * *credit_note_deleted*
25
+ * Following attributes are added to [line_items[]](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) sub-resource:
26
+ * *discount_amount* - the total discount amount (both item-level and document-level discounts) of this line.
27
+ * *item_level_discount_amount* - only the item-level-discount amount component.
28
+ * 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*.
29
+ * 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)
24
30
 
25
31
  ### v1.7.2 (2016-04-06)
26
32
  * * *
@@ -28,7 +34,7 @@
28
34
  *api_version* attribute is added to the Event resource.
29
35
 
30
36
  Chargebee supports multiple [API versions](https://apidocs.chargebee.com/docs/api#versions) now. The *api_version* attribute indicates the API version based on which the event content is structured. More details here:
31
- https://apidocs.chargebee.com/docs/api/v1/events
37
+ https://apidocs.chargebee.com/docs/api/events
32
38
 
33
39
  ### v1.7.1 (2016-03-22)
34
40
  * * *
@@ -36,26 +42,26 @@ https://apidocs.chargebee.com/docs/api/v1/events
36
42
  ** APIs updated**:
37
43
 
38
44
  Support to specify additional information as "meta_data" in json format for Customer, Subscription, Plan, Addon & Coupon resources.
39
- Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
45
+ Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
40
46
 
41
- New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
47
+ New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
42
48
 
43
49
 
44
50
  ** APIs added**:
45
51
 
46
- Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/v1/cards#switch_gateway
52
+ Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/cards#switch_gateway
47
53
 
48
54
 
49
55
  ** Issue Fixed**:
50
56
 
51
- Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/v1/invoices
57
+ Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/invoices
52
58
 
53
59
  ### v1.7.0 (2016-03-10)
54
60
  * * *
55
61
 
56
62
  ** APIs updated**:
57
63
 
58
- Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/v1/customers#delete_a_customer
64
+ Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
59
65
 
60
66
  Typo fix in chargebee.gemspec file.
61
67
 
@@ -68,16 +74,16 @@ RSpec development dependancy version has been upgraded to 3.0.0
68
74
 
69
75
  Support to delete a subscription. See: https://www.chargebee.com/docs/subscriptions.html#deleting-a-subscription
70
76
  New api endpoint to delete 'Subscription' is added to Subscription resources. See delete subscription API here:
71
- https://apidocs.chargebee.com/docs/api/v1/subscriptions#delete_a_subscription
77
+ https://apidocs.chargebee.com/docs/api/subscriptions#delete_a_subscription
72
78
 
73
79
  Support to delete a customer. See: https://www.chargebee.com/docs/customers.html#deleting-a-customer
74
80
  New api endpoint to delete 'Customer' is added to Customer resources. See delete customer API here:
75
- https://apidocs.chargebee.com/docs/api/v1/customers#delete_a_customer
81
+ https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
76
82
 
77
83
 
78
84
  ** APIs updated**:
79
85
 
80
- Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types.
86
+ Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
81
87
 
82
88
  ### v1.6.8 (2016-02-08)
83
89
  * * *
@@ -85,22 +91,22 @@ Now, events "subscription_deleted" & "customer_deleted" can be fetched via API.
85
91
  ** APIs added**:
86
92
 
87
93
  Support to add additional contact for a customer. See: https://www.chargebee.com/docs/customers.html#add-contact
88
- New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/v1/customers#add_contacts_to_a_customer
94
+ New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/customers#add_contacts_to_a_customer
89
95
 
90
96
  ** APIs updated**:
91
97
 
92
- New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
98
+ New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
93
99
 
94
- Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice
100
+ Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice
95
101
 
96
102
  New attribute 'refundable_credits' is returned as part of Customer resource.
97
103
 
98
- New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
104
+ New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
99
105
 
100
- New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
106
+ New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
101
107
 
102
108
  New entity type 'credit_note' is added as part of 'entity_type' attribute of Comment resource.
103
- See: https://apidocs.chargebee.com/docs/api/v1/comments#comment_attributes
109
+ See: https://apidocs.chargebee.com/docs/api/comments#comment_attributes
104
110
 
105
111
  ### v1.6.7 (2015-12-15)
106
112
  * * *
@@ -114,10 +120,10 @@ Wrong API invocation issue if empty/null value passed instead of resource id, is
114
120
 
115
121
  ** APIs updated**:
116
122
 
117
- Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/v1/plans#create_a_plan
123
+ Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
118
124
 
119
125
  New attribute "enabled_in_portal" is returned as part of Plan/Addon resource.
120
- See plan attributes here: https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
126
+ See plan attributes here: https://apidocs.chargebee.com/docs/api/plans#plan_attributes
121
127
 
122
128
  ### v1.6.5 (2015-11-09)
123
129
  * * *
@@ -127,57 +133,57 @@ See plan attributes here: https://apidocs.chargebee.com/docs/api/v1/plans#plan_a
127
133
  Support for excess payments. See : https://www.chargebee.com/docs/customers.html#excess-payments
128
134
 
129
135
  New attribute "excess_payments" is returned as part of Customer resource.
130
- See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
136
+ See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
131
137
 
132
138
  New attribute "applied_at" is returned as part of Linked Transaction subresource of Invoice resource.
133
- See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
139
+ See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
134
140
 
135
141
  New transaction type "PAYMENT_REVERSAL" is returned as part of Transaction resource.
136
- See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
142
+ See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
137
143
 
138
144
  New attributes "amount_unused", "reference_transaction_id", "reversal_transaction_id" & "linked_refunds" subresource are returned as part of Transaction resource.
139
145
 
140
146
  New attribute "applied_at" is returmed as part of Linked Invoice subresource of Transaction resource.
141
- See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
147
+ See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
142
148
 
143
149
  ### v1.6.4 (2015-10-26)
144
150
  * * *
145
151
 
146
152
  ** APIs updated**:
147
153
 
148
- Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
154
+ Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
149
155
 
150
156
  New attribute "allow_direct_debit" is returned as part of Customer resource.
151
- See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
157
+ See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
152
158
 
153
159
  New "price_type" attribute is returned as part of Estimate & Invoice Resource.
154
- See : https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
160
+ See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
155
161
 
156
162
  Support for address parameters in estimate APIs that is used to calculate tax. Now, create & update subscription estimate APIs accept billing state code, billing zip, shipping country, shipping state code & shipping zip.
157
- See : https://apidocs.chargebee.com/docs/api/v1/estimates#create_subscription_estimate
163
+ See : https://apidocs.chargebee.com/docs/api/estimates#create_subscription_estimate
158
164
 
159
165
  ### v1.6.3 (2015-09-18)
160
166
  * * *
161
167
 
162
168
  ** APIs updated**:
163
169
 
164
- Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
170
+ Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
165
171
 
166
- Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/v1/plans#create_a_plan
172
+ Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
167
173
 
168
174
  The attribute "taxablility" is returned as part of Customer resource.
169
- https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
175
+ https://apidocs.chargebee.com/docs/api/customers#customer_attributes
170
176
 
171
177
  The attribute "taxable" is returned as part of Plan resource.
172
- See : https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
178
+ See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
173
179
 
174
180
  The attribute "taxable" is returned as part of Addon resource.
175
- See : https://apidocs.chargebee.com/docs/api/v1/addons#addon_attributes
181
+ See : https://apidocs.chargebee.com/docs/api/addons#addon_attributes
176
182
 
177
183
 
178
184
  The attribute "is_taxed" returned as part of "line_items" subresource of Estimate & Invoice resorces.
179
185
  See attribute of line_items in Estimate here :
180
- https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
186
+ https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
181
187
 
182
188
  ### v1.6.2 (2015-09-07)
183
189
  * * *
@@ -185,10 +191,10 @@ https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
185
191
  ** APIs updated**:
186
192
 
187
193
  The attribute for "user" is returned as part of Event resource.
188
- See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
194
+ See : https://apidocs.chargebee.com/docs/api/events#event_attributes
189
195
 
190
196
  Support for multiple webhooks. The attribute "webhooks" contains list of Webhook subresource is returned as part of Event API.
191
- See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
197
+ See : https://apidocs.chargebee.com/docs/api/events#event_attributes
192
198
 
193
199
  ** APIs deprecated**:
194
200
 
@@ -200,40 +206,40 @@ Attributes "webhook_status" & "webhook_failure_reason" of event resource has bee
200
206
  ** APIs updated**:
201
207
 
202
208
  The attribute for "first_invoice" & "currency_code" is returned as part of Invoice resource.
203
- See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
209
+ See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
204
210
 
205
211
  The attribute for "currency_code" is returned as part of Transaction resource.
206
- See : https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
212
+ See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
207
213
 
208
214
  A new source type "bulk_operation" is returned as part of "source" attribute of event resource.
209
- See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
215
+ See : https://apidocs.chargebee.com/docs/api/events#event_attributes
210
216
 
211
217
  ### v1.6.0 (2015-07-20)
212
218
  * * *
213
219
 
214
220
  ** APIs added**:
215
221
 
216
- New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#stop_dunning_for_invoice
222
+ New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/invoices#stop_dunning_for_invoice
217
223
 
218
224
  ** APIs updated**:
219
225
 
220
226
  The attribute for "dunning_status" is returned as part of Invoice resource.
221
- See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
227
+ See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
222
228
 
223
229
  ### v1.5.9 (2015-07-09)
224
230
  * * *
225
231
 
226
232
  ** APIs added**:
227
233
 
228
- New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#record_refund_for_an_invoice
234
+ New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#record_refund_for_an_invoice
229
235
 
230
236
  ** APIs updated**:
231
237
 
232
- Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer
238
+ Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer
233
239
 
234
- The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
240
+ The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
235
241
 
236
- A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
242
+ A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
237
243
 
238
244
  A new discount type "account_credits" is added as part of "type" attribute of discounts sub-resource for estimate resource.
239
245
 
@@ -246,34 +252,34 @@ Attributes "description" & "void_description" of transaction resource has been d
246
252
 
247
253
  ** APIs added**:
248
254
 
249
- New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#void_an_invoice
255
+ New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#void_an_invoice
250
256
 
251
257
  ** APIs updated**:
252
258
 
253
- A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
259
+ A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
254
260
 
255
261
  ** APIs deprecated**:
256
262
 
257
- Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/v1/hosted_pages#update_payment_method
263
+ Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method
258
264
 
259
265
  ### v1.5.7 (2015-06-12)
260
266
  * * *
261
267
 
262
268
  ** APIs added**:
263
269
 
264
- New api endpoints to Add, Deduct & Set the account credit for a customer is added. See the APIs below - https://apidocs.chargebee.com/docs/api/v1/customers#add_account_credits_to_a_customer
265
- https://apidocs.chargebee.com/docs/api/v1/customers#deduct_account_credits_for_a_customer
266
- https://apidocs.chargebee.com/docs/api/v1/customers#set_account_credits_for_a_customer
270
+ 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
271
+ https://apidocs.chargebee.com/docs/api/customers#deduct_account_credits_for_a_customer
272
+ https://apidocs.chargebee.com/docs/api/customers#set_account_credits_for_a_customer
267
273
 
268
274
  ** APIs updated**:
269
275
 
270
- Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types.
276
+ Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
271
277
 
272
- A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
278
+ A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
273
279
 
274
- The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
280
+ The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
275
281
 
276
- A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
282
+ A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
277
283
 
278
284
  ** APIs deprecated**:
279
285
 
@@ -288,9 +294,9 @@ The attribute "discount_quantity" deprecated for Create method of Coupon API.
288
294
 
289
295
  ** APIs added**:
290
296
 
291
- A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer.
297
+ A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer.
292
298
 
293
- A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice.
299
+ A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice.
294
300
 
295
301
  ** APIs updated**:
296
302
 
@@ -309,15 +315,15 @@ The resource attribute for "po_number" is returned as part of Subscription and I
309
315
  Create and Update methods of plan, addon, coupon, customer and subscripiton APIs now accept "invoice_notes" that is added to the invoice raised for a customer. Read more about invoice notes : https://www.chargebee.com/docs/invoice_notes.html
310
316
 
311
317
  A new sub-resource "notes" is returned as part of the Invoice resource attributes.
312
- See https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
318
+ See https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
313
319
 
314
320
  A new attribute "amount_due" is returned as part of Invoice resource.
315
321
 
316
322
  Checkout new, checkout existing, update payment method method APIs now accept "redirect_url" & "cancel_url" to which your customer should be redirected.
317
- See https://apidocs.chargebee.com/docs/api/v1/hosted_pages#checkout_new_subscription
323
+ See https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
318
324
 
319
325
  Now, event "subscription_renewal_reminder" can be fetched via API.
320
- See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
326
+ See https://apidocs.chargebee.com/docs/api/events#event_types.
321
327
 
322
328
  ### v1.5.4 (2015-03-30)
323
329
  * * *
@@ -325,23 +331,23 @@ See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
325
331
  ** APIs added**:
326
332
 
327
333
  A new API "Delete an Invoice" added to delete un-paid invoices. This feature was supported through admin console earlier, now it is available via API too.
328
- See https://apidocs.chargebee.com/docs/api/v1/invoices#delete_an_invoice.
334
+ See https://apidocs.chargebee.com/docs/api/invoices#delete_an_invoice.
329
335
 
330
336
  ** APIs updated**:
331
337
 
332
338
  Create subscription/customer, update subscription/payment method APIs now accepts the IP Address of customer for card resource.
333
339
 
334
340
  Now, event "invoice_deleted" can be fetched via API.
335
- See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
341
+ See https://apidocs.chargebee.com/docs/api/events#event_types.
336
342
 
337
343
  ### v1.5.3 (2015-02-27)
338
344
  * * *
339
345
 
340
346
  ** APIs added**:
341
347
 
342
- A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#create_an_invoice.
348
+ A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/invoices#create_an_invoice.
343
349
 
344
- A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/v1/portal_sessions.
350
+ A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/portal_sessions.
345
351
 
346
352
  ** APIs updated**:
347
353
 
@@ -367,7 +373,7 @@ Create subscription/customer, update subscription/customer/payment method/billin
367
373
  Support for PayPal & Amazon payment added.
368
374
 
369
375
  ** APIs added**:
370
- A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/v1/hosted_pages#update_payment_method for details.
376
+ A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method for details.
371
377
 
372
378
  ** APIs deprecated**:
373
379
  Update card(HostedPage) API is deprecated as an alternate API is added.
@@ -380,10 +386,10 @@ Create a customer API now accepts the end user IP.
380
386
 
381
387
  **APIs added**:
382
388
  A new resource called Order is introduced. This can be used for integrating ChargeBee with any shipping/order management application (like ShipStation). Orders are not automatically generated or updated by ChargeBee currently. They have to be created/updated either via api or merchant web console (a.k.a admin console). An order can be created against an invoice irrespective of the status of the invoice and an invoice can have multiple orders associated with it.
383
- See https://apidocs.chargebee.com/docs/api/v1/orders?lang=ruby for details.
389
+ See https://apidocs.chargebee.com/docs/api/orders?lang=ruby for details.
384
390
 
385
391
  **API Updates**:
386
- Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#list_invoices.
392
+ Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices.
387
393
 
388
394
  ### v1.4.9 (2014-11-24)
389
395
  * * *
@@ -401,7 +407,7 @@ Bug fixes.
401
407
  * * *
402
408
 
403
409
  **APIs Updated**:
404
- * Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/v1/customers#update_a_customer.
410
+ * Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/customers#update_a_customer.
405
411
 
406
412
  ### v1.4.6 (2014-09-16)
407
413
  * * *
@@ -435,8 +441,8 @@ Added properties:
435
441
  * Property has_scheduled_changes added to the Subscription resource to indicate whether there are any pending change scheduled for this Subscription
436
442
 
437
443
  APIs added:
438
- * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#retrieve_with_scheduled_changes.
439
- * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#remove_scheduled_changes.
444
+ * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/subscriptions#retrieve_with_scheduled_changes.
445
+ * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/subscriptions#remove_scheduled_changes.
440
446
 
441
447
  APIs updated:
442
448
  * Ability to pass description for Plans & Addons while Creating & Updating.
@@ -447,33 +453,33 @@ APIs Removed:
447
453
  ### v1.4.3 (2014-07-29)
448
454
  * * *
449
455
  APIs added:
450
- * Add a one time charged to the subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#add_charge_at_term_end.
451
- * Add a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#charge_addon_at_term_end.
452
- *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/v1/estimates#subscription_renewal_estimate
456
+ * 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.
457
+ * 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.
458
+ *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate
453
459
 
454
460
  APIs updated:
455
- * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
461
+ * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/plans#plan_attributes
456
462
  * Include delayed charges while calculating the Estimate.
457
463
 
458
464
  ### v1.4.2 (2014-06-19)
459
465
  * * *
460
466
  APIs added:
461
- * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#list_invoices_for_a_customer.
462
- * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/v1/transactions?lang=ruby#list_transactions_for_a_customer.
467
+ * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices_for_a_customer.
468
+ * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/transactions?lang=ruby#list_transactions_for_a_customer.
463
469
 
464
470
  APIs updated:
465
- * Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#create_invoice_for_charge.
466
- * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#create_invoice_for_addon.
471
+ * 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.
472
+ * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#create_invoice_for_addon.
467
473
 
468
474
  ### v1.4.1 (2014-05-28)
469
475
  * * *
470
- New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions?lang=ruby.
476
+ New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/portal_sessions?lang=ruby.
471
477
 
472
478
  ### v1.4.0 (2014-05-23)
473
479
  * * *
474
- * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
480
+ * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/customers#create_a_customer
475
481
 
476
- * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#list_invoices_for_a_customer
482
+ * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/invoices#list_invoices_for_a_customer
477
483
 
478
484
  * Customer id reference is added to the invoice attributes.
479
485
 
@@ -483,15 +489,15 @@ Support for returning shipping address as part of create/update subscription API
483
489
 
484
490
  ### v1.3.8 (2014-03-26)
485
491
  * * *
486
- * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices.
492
+ * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices.
487
493
 
488
- * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions.
494
+ * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions.
489
495
 
490
- * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/v1/transactions#record_payment_for_an_invoice "Record Payment for an Invoice")
496
+ * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/transactions#record_payment_for_an_invoice "Record Payment for an Invoice")
491
497
 
492
498
  ### v1.3.7 (2014-03-18)
493
499
  * * *
494
- Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/v1/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/v1/addons#delete_an_addon "Delete an addon").
500
+ Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/addons#delete_an_addon "Delete an addon").
495
501
 
496
502
  ### v1.3.6 (2014-03-10)
497
503
  * * *