bf_ruby2 1.2016.229 → 1.2016.230

Sign up to get free protection for your applications and to get access to all the features.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +53 -29
  3. data/bf_ruby2-1.2016.229.gem +0 -0
  4. data/docs/AccountsApi.md +82 -31
  5. data/docs/AddChargeToAccountResponse.md +9 -0
  6. data/docs/AddChargeToAccountResponsePagedMetadata.md +14 -0
  7. data/docs/AddChargesToAccountAPIRequest.md +17 -0
  8. data/docs/AddressesApi.md +4 -4
  9. data/docs/AmendmentsApi.md +13 -13
  10. data/docs/AnalyticsApi.md +15 -15
  11. data/docs/AuditlogsApi.md +5 -5
  12. data/docs/BatchUpdatePricingComponentValuesRequest.md +9 -0
  13. data/docs/ChargesApi.md +56 -8
  14. data/docs/ClientsApi.md +6 -6
  15. data/docs/ConfigurationsApi.md +6 -6
  16. data/docs/CouponbookApi.md +11 -11
  17. data/docs/CouponbookdefinitionApi.md +8 -8
  18. data/docs/CoupondefinitionApi.md +7 -7
  19. data/docs/CouponinstanceApi.md +12 -12
  20. data/docs/CouponmodifierApi.md +9 -9
  21. data/docs/CouponruleApi.md +6 -6
  22. data/docs/CouponsApi.md +10 -10
  23. data/docs/CreateSubscriptionChargeAmendment.md +0 -1
  24. data/docs/CreateSubscriptionRequest.md +2 -0
  25. data/docs/CreditnotesApi.md +7 -7
  26. data/docs/CybersourcetokensApi.md +7 -7
  27. data/docs/DunninglinesApi.md +8 -8
  28. data/docs/EmailprovidersApi.md +5 -5
  29. data/docs/EmailsApi.md +1 -1
  30. data/docs/EmailsubscriptionsApi.md +7 -7
  31. data/docs/FixedtermdefinitionsApi.md +4 -4
  32. data/docs/FixedtermsApi.md +2 -2
  33. data/docs/Invoice.md +3 -0
  34. data/docs/InvoicesApi.md +63 -63
  35. data/docs/MetadataApi.md +6 -6
  36. data/docs/NestedChargeRequest.md +19 -0
  37. data/docs/NotificationsApi.md +6 -6
  38. data/docs/OrganizationsApi.md +9 -9
  39. data/docs/PasswordsApi.md +2 -2
  40. data/docs/PaymentmethodsApi.md +10 -10
  41. data/docs/PaymentmethodsubscriptionlinksApi.md +3 -3
  42. data/docs/PaymentsApi.md +9 -9
  43. data/docs/PeriodsApi.md +2 -2
  44. data/docs/PermissionsApi.md +8 -8
  45. data/docs/PricingcalculatorApi.md +6 -6
  46. data/docs/PricingcomponentsApi.md +8 -8
  47. data/docs/PricingcomponenttiersApi.md +7 -7
  48. data/docs/PricingcomponentvaluechangesApi.md +7 -7
  49. data/docs/PricingcomponentvaluesApi.md +7 -7
  50. data/docs/ProductrateplansApi.md +27 -27
  51. data/docs/ProductsApi.md +17 -17
  52. data/docs/ProfilesApi.md +6 -6
  53. data/docs/QuotesApi.md +2 -2
  54. data/docs/RecalculateChargeBatchRequest.md +12 -0
  55. data/docs/RecalculateChargeBatchResponse.md +11 -0
  56. data/docs/RecalculateChargeBatchResponsePagedMetadata.md +14 -0
  57. data/docs/ReceiptsApi.md +6 -6
  58. data/docs/RefundsApi.md +9 -9
  59. data/docs/RolesApi.md +8 -8
  60. data/docs/SearchApi.md +1 -1
  61. data/docs/SingleRecalculateChargeRequest.md +15 -0
  62. data/docs/Subscription.md +1 -0
  63. data/docs/SubscriptionsApi.md +153 -102
  64. data/docs/SynchAppConfigsApi.md +6 -6
  65. data/docs/SynchConfigsApi.md +8 -8
  66. data/docs/SynchJobsApi.md +10 -10
  67. data/docs/TaxationlinksApi.md +8 -8
  68. data/docs/TaxationstrategiesApi.md +11 -11
  69. data/docs/TimeApi.md +1 -1
  70. data/docs/TokenizationApi.md +6 -6
  71. data/docs/UnitofmeasureApi.md +6 -6
  72. data/docs/UpdatePricingComponentValueChangeResult.md +19 -0
  73. data/docs/UpdatePricingComponentValueRequest.md +10 -0
  74. data/docs/UpdatePricingComponentValueResponse.md +9 -0
  75. data/docs/UpdatePricingComponentValueResponsePagedMetadata.md +14 -0
  76. data/docs/UsageApi.md +7 -7
  77. data/docs/UsageperiodsApi.md +3 -3
  78. data/docs/UsageroundingstrategiesApi.md +6 -6
  79. data/docs/UsagesessionsApi.md +6 -6
  80. data/docs/UsernamesApi.md +2 -2
  81. data/docs/UsersApi.md +16 -16
  82. data/docs/VaultedgatewaysApi.md +22 -22
  83. data/docs/WebhooksApi.md +10 -10
  84. data/lib/bf_ruby2.rb +13 -0
  85. data/lib/bf_ruby2/api/accounts_api.rb +92 -31
  86. data/lib/bf_ruby2/api/addresses_api.rb +4 -4
  87. data/lib/bf_ruby2/api/amendments_api.rb +13 -13
  88. data/lib/bf_ruby2/api/analytics_api.rb +15 -15
  89. data/lib/bf_ruby2/api/auditlogs_api.rb +5 -5
  90. data/lib/bf_ruby2/api/charges_api.rb +65 -8
  91. data/lib/bf_ruby2/api/clients_api.rb +6 -6
  92. data/lib/bf_ruby2/api/configurations_api.rb +6 -6
  93. data/lib/bf_ruby2/api/couponbook_api.rb +11 -11
  94. data/lib/bf_ruby2/api/couponbookdefinition_api.rb +8 -8
  95. data/lib/bf_ruby2/api/coupondefinition_api.rb +7 -7
  96. data/lib/bf_ruby2/api/couponinstance_api.rb +12 -12
  97. data/lib/bf_ruby2/api/couponmodifier_api.rb +9 -9
  98. data/lib/bf_ruby2/api/couponrule_api.rb +6 -6
  99. data/lib/bf_ruby2/api/coupons_api.rb +10 -10
  100. data/lib/bf_ruby2/api/creditnotes_api.rb +7 -7
  101. data/lib/bf_ruby2/api/cybersourcetokens_api.rb +7 -7
  102. data/lib/bf_ruby2/api/dunninglines_api.rb +8 -8
  103. data/lib/bf_ruby2/api/emailproviders_api.rb +5 -5
  104. data/lib/bf_ruby2/api/emails_api.rb +1 -1
  105. data/lib/bf_ruby2/api/emailsubscriptions_api.rb +7 -7
  106. data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +4 -4
  107. data/lib/bf_ruby2/api/fixedterms_api.rb +2 -2
  108. data/lib/bf_ruby2/api/invoices_api.rb +63 -63
  109. data/lib/bf_ruby2/api/metadata_api.rb +6 -6
  110. data/lib/bf_ruby2/api/notifications_api.rb +6 -6
  111. data/lib/bf_ruby2/api/organizations_api.rb +9 -9
  112. data/lib/bf_ruby2/api/passwords_api.rb +2 -2
  113. data/lib/bf_ruby2/api/paymentmethods_api.rb +10 -10
  114. data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +3 -3
  115. data/lib/bf_ruby2/api/payments_api.rb +9 -9
  116. data/lib/bf_ruby2/api/periods_api.rb +2 -2
  117. data/lib/bf_ruby2/api/permissions_api.rb +8 -8
  118. data/lib/bf_ruby2/api/pricingcalculator_api.rb +6 -6
  119. data/lib/bf_ruby2/api/pricingcomponents_api.rb +8 -8
  120. data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +7 -7
  121. data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +7 -7
  122. data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +7 -7
  123. data/lib/bf_ruby2/api/productrateplans_api.rb +27 -27
  124. data/lib/bf_ruby2/api/products_api.rb +17 -17
  125. data/lib/bf_ruby2/api/profiles_api.rb +6 -6
  126. data/lib/bf_ruby2/api/quotes_api.rb +2 -2
  127. data/lib/bf_ruby2/api/receipts_api.rb +6 -6
  128. data/lib/bf_ruby2/api/refunds_api.rb +9 -9
  129. data/lib/bf_ruby2/api/roles_api.rb +8 -8
  130. data/lib/bf_ruby2/api/search_api.rb +1 -1
  131. data/lib/bf_ruby2/api/subscriptions_api.rb +163 -102
  132. data/lib/bf_ruby2/api/synch_app_configs_api.rb +6 -6
  133. data/lib/bf_ruby2/api/synch_configs_api.rb +8 -8
  134. data/lib/bf_ruby2/api/synch_jobs_api.rb +10 -10
  135. data/lib/bf_ruby2/api/taxationlinks_api.rb +8 -8
  136. data/lib/bf_ruby2/api/taxationstrategies_api.rb +11 -11
  137. data/lib/bf_ruby2/api/time_api.rb +1 -1
  138. data/lib/bf_ruby2/api/tokenization_api.rb +6 -6
  139. data/lib/bf_ruby2/api/unitofmeasure_api.rb +6 -6
  140. data/lib/bf_ruby2/api/usage_api.rb +7 -7
  141. data/lib/bf_ruby2/api/usageperiods_api.rb +3 -3
  142. data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +6 -6
  143. data/lib/bf_ruby2/api/usagesessions_api.rb +6 -6
  144. data/lib/bf_ruby2/api/usernames_api.rb +2 -2
  145. data/lib/bf_ruby2/api/users_api.rb +16 -16
  146. data/lib/bf_ruby2/api/vaultedgateways_api.rb +22 -22
  147. data/lib/bf_ruby2/api/webhooks_api.rb +10 -10
  148. data/lib/bf_ruby2/models/add_charge_to_account_response.rb +212 -0
  149. data/lib/bf_ruby2/models/add_charge_to_account_response_paged_metadata.rb +269 -0
  150. data/lib/bf_ruby2/models/add_charges_to_account_api_request.rb +337 -0
  151. data/lib/bf_ruby2/models/batch_update_pricing_component_values_request.rb +244 -0
  152. data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +1 -24
  153. data/lib/bf_ruby2/models/create_subscription_request.rb +24 -4
  154. data/lib/bf_ruby2/models/invoice.rb +32 -1
  155. data/lib/bf_ruby2/models/nested_charge_request.rb +343 -0
  156. data/lib/bf_ruby2/models/recalculate_charge_batch_request.rb +279 -0
  157. data/lib/bf_ruby2/models/recalculate_charge_batch_response.rb +234 -0
  158. data/lib/bf_ruby2/models/recalculate_charge_batch_response_paged_metadata.rb +269 -0
  159. data/lib/bf_ruby2/models/single_recalculate_charge_request.rb +317 -0
  160. data/lib/bf_ruby2/models/subscription.rb +11 -1
  161. data/lib/bf_ruby2/models/update_pricing_component_value_change_result.rb +367 -0
  162. data/lib/bf_ruby2/models/update_pricing_component_value_request.rb +253 -0
  163. data/lib/bf_ruby2/models/update_pricing_component_value_response.rb +210 -0
  164. data/lib/bf_ruby2/models/update_pricing_component_value_response_paged_metadata.rb +269 -0
  165. data/lib/bf_ruby2/version.rb +1 -1
  166. data/spec/models/add_charge_to_account_response_paged_metadata_spec.rb +89 -0
  167. data/spec/models/add_charge_to_account_response_spec.rb +59 -0
  168. data/spec/models/add_charges_to_account_api_request_spec.rb +115 -0
  169. data/spec/models/batch_update_pricing_component_values_request_spec.rb +63 -0
  170. data/spec/models/nested_charge_request_spec.rb +123 -0
  171. data/spec/models/recalculate_charge_batch_request_spec.rb +81 -0
  172. data/spec/models/recalculate_charge_batch_response_paged_metadata_spec.rb +89 -0
  173. data/spec/models/recalculate_charge_batch_response_spec.rb +71 -0
  174. data/spec/models/single_recalculate_charge_request_spec.rb +103 -0
  175. data/spec/models/update_pricing_component_value_change_result_spec.rb +131 -0
  176. data/spec/models/update_pricing_component_value_request_spec.rb +69 -0
  177. data/spec/models/update_pricing_component_value_response_paged_metadata_spec.rb +89 -0
  178. data/spec/models/update_pricing_component_value_response_spec.rb +59 -0
  179. metadata +54 -2
  180. data/setup.scratch.rb +0 -33
data/docs/QuotesApi.md CHANGED
@@ -49,8 +49,8 @@ No authorization required
49
49
 
50
50
  ### HTTP request headers
51
51
 
52
- - **Content-Type**: application/json
53
- - **Accept**: application/json
52
+ - **Content-Type**: application/json; charset=utf-8
53
+ - **Accept**: application/json; charset=utf-8
54
54
 
55
55
 
56
56
 
@@ -0,0 +1,12 @@
1
+ # BillForward::RecalculateChargeBatchRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **charges** | [**Array<SingleRecalculateChargeRequest>**](SingleRecalculateChargeRequest.md) | {\"description\":\"Charges to recalculate.\",\"verbs\":[\"POST\"]} | [optional]
7
+ **organization_id** | **String** | {\"default\":\"(Auto-populated using your authentication credentials) ID of the organization actioning this request.\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional]
8
+ **dry_run** | **BOOLEAN** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to false]
9
+ **recalculate_invoices** | **BOOLEAN** | { \"description\" : \"Whether the invoice of any charge to be recalculated should also be recalculated.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] [default to true]
10
+ **invoice_state** | **String** | {\"default\":null (invoice is raised in its default initial state),\"description\":\"The new state recalculated invoices should be created as. \",\"verbs\":[\"POST\",\"GET\"]} | [optional]
11
+
12
+
@@ -0,0 +1,11 @@
1
+ # BillForward::RecalculateChargeBatchResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **charges** | [**Array<SubscriptionCharge>**](SubscriptionCharge.md) | | [optional]
7
+ **recalculated_invoices** | [**Array<Invoice>**](Invoice.md) | | [optional]
8
+ **organization_id** | **String** | | [optional]
9
+ **recalculate_invoices** | **BOOLEAN** | | [optional]
10
+
11
+
@@ -0,0 +1,14 @@
1
+ # BillForward::RecalculateChargeBatchResponsePagedMetadata
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
7
+ **current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
8
+ **current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
9
+ **records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
10
+ **records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
11
+ **execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
12
+ **results** | [**Array<RecalculateChargeBatchResponse>**](RecalculateChargeBatchResponse.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
13
+
14
+
data/docs/ReceiptsApi.md CHANGED
@@ -55,8 +55,8 @@ No authorization required
55
55
 
56
56
  ### HTTP request headers
57
57
 
58
- - **Content-Type**: application/json
59
- - **Accept**: text/xml, application/xml, application/json
58
+ - **Content-Type**: application/json; charset=utf-8
59
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
60
60
 
61
61
 
62
62
 
@@ -124,7 +124,7 @@ No authorization required
124
124
  ### HTTP request headers
125
125
 
126
126
  - **Content-Type**: Not defined
127
- - **Accept**: application/json
127
+ - **Accept**: application/json; charset=utf-8
128
128
 
129
129
 
130
130
 
@@ -175,7 +175,7 @@ No authorization required
175
175
  ### HTTP request headers
176
176
 
177
177
  - **Content-Type**: text/plain
178
- - **Accept**: application/json
178
+ - **Accept**: application/json; charset=utf-8
179
179
 
180
180
 
181
181
 
@@ -234,7 +234,7 @@ No authorization required
234
234
  ### HTTP request headers
235
235
 
236
236
  - **Content-Type**: text/plain
237
- - **Accept**: application/json
237
+ - **Accept**: application/json; charset=utf-8
238
238
 
239
239
 
240
240
 
@@ -293,7 +293,7 @@ No authorization required
293
293
  ### HTTP request headers
294
294
 
295
295
  - **Content-Type**: text/plain
296
- - **Accept**: application/json
296
+ - **Accept**: application/json; charset=utf-8
297
297
 
298
298
 
299
299
 
data/docs/RefundsApi.md CHANGED
@@ -56,8 +56,8 @@ No authorization required
56
56
 
57
57
  ### HTTP request headers
58
58
 
59
- - **Content-Type**: application/json
60
- - **Accept**: text/xml, application/xml, application/json
59
+ - **Content-Type**: application/json; charset=utf-8
60
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
61
61
 
62
62
 
63
63
 
@@ -113,7 +113,7 @@ No authorization required
113
113
  ### HTTP request headers
114
114
 
115
115
  - **Content-Type**: Not defined
116
- - **Accept**: application/json
116
+ - **Accept**: application/json; charset=utf-8
117
117
 
118
118
 
119
119
 
@@ -164,7 +164,7 @@ No authorization required
164
164
  ### HTTP request headers
165
165
 
166
166
  - **Content-Type**: text/plain
167
- - **Accept**: application/json
167
+ - **Accept**: application/json; charset=utf-8
168
168
 
169
169
 
170
170
 
@@ -215,7 +215,7 @@ No authorization required
215
215
  ### HTTP request headers
216
216
 
217
217
  - **Content-Type**: text/plain
218
- - **Accept**: application/json
218
+ - **Accept**: application/json; charset=utf-8
219
219
 
220
220
 
221
221
 
@@ -266,7 +266,7 @@ No authorization required
266
266
  ### HTTP request headers
267
267
 
268
268
  - **Content-Type**: text/plain
269
- - **Accept**: application/json
269
+ - **Accept**: application/json; charset=utf-8
270
270
 
271
271
 
272
272
 
@@ -317,7 +317,7 @@ No authorization required
317
317
  ### HTTP request headers
318
318
 
319
319
  - **Content-Type**: text/plain
320
- - **Accept**: application/json
320
+ - **Accept**: application/json; charset=utf-8
321
321
 
322
322
 
323
323
 
@@ -425,8 +425,8 @@ No authorization required
425
425
 
426
426
  ### HTTP request headers
427
427
 
428
- - **Content-Type**: application/json
429
- - **Accept**: text/xml, application/xml, application/json
428
+ - **Content-Type**: application/json; charset=utf-8
429
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
430
430
 
431
431
 
432
432
 
data/docs/RolesApi.md CHANGED
@@ -54,8 +54,8 @@ No authorization required
54
54
 
55
55
  ### HTTP request headers
56
56
 
57
- - **Content-Type**: application/json
58
- - **Accept**: text/xml, application/xml, application/json
57
+ - **Content-Type**: application/json; charset=utf-8
58
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
59
59
 
60
60
 
61
61
 
@@ -113,7 +113,7 @@ No authorization required
113
113
  ### HTTP request headers
114
114
 
115
115
  - **Content-Type**: Not defined
116
- - **Accept**: application/json
116
+ - **Accept**: application/json; charset=utf-8
117
117
 
118
118
 
119
119
 
@@ -166,7 +166,7 @@ No authorization required
166
166
  ### HTTP request headers
167
167
 
168
168
  - **Content-Type**: text/plain
169
- - **Accept**: application/json
169
+ - **Accept**: application/json; charset=utf-8
170
170
 
171
171
 
172
172
 
@@ -223,7 +223,7 @@ No authorization required
223
223
  ### HTTP request headers
224
224
 
225
225
  - **Content-Type**: text/plain
226
- - **Accept**: application/json
226
+ - **Accept**: application/json; charset=utf-8
227
227
 
228
228
 
229
229
 
@@ -274,7 +274,7 @@ No authorization required
274
274
  ### HTTP request headers
275
275
 
276
276
  - **Content-Type**: text/plain
277
- - **Accept**: application/json
277
+ - **Accept**: application/json; charset=utf-8
278
278
 
279
279
 
280
280
 
@@ -320,8 +320,8 @@ No authorization required
320
320
 
321
321
  ### HTTP request headers
322
322
 
323
- - **Content-Type**: application/json
324
- - **Accept**: text/xml, application/xml, application/json
323
+ - **Content-Type**: application/json; charset=utf-8
324
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
325
325
 
326
326
 
327
327
 
data/docs/SearchApi.md CHANGED
@@ -64,7 +64,7 @@ No authorization required
64
64
  ### HTTP request headers
65
65
 
66
66
  - **Content-Type**: text/plain
67
- - **Accept**: application/json
67
+ - **Accept**: application/json; charset=utf-8
68
68
 
69
69
 
70
70
 
@@ -0,0 +1,15 @@
1
+ # BillForward::SingleRecalculateChargeRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | {\"description\":\"The unique id of the charge to be recalculated.\",\"verbs\":[\"POST\",\"GET\"]} |
7
+ **name** | **String** | {\"description\":\"New friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
8
+ **description** | **String** | {\"description\":\"New description given to the charge.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
9
+ **amount** | **Float** | {\"description\":\"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)<br>New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).<br>This amount excludes tax.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
10
+ **invoicing_type** | **String** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"The strategy for how to raise invoices describing the charges produced by this charge recalculation.<br><span class=\\\"label label-default\\\">Immediate</span> — Generate straight-away an invoice containing these charges.<br><span class=\\\"label label-default\\\">Aggregated</span> — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
11
+ **pricing_component_value** | **Integer** | {\"description\":\"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)<br>The updated value consumed of the pricing component which this charge concerns.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
12
+ **recalculation_behaviour** | **String** | {\"default\":\"RecalculateWithLatestPricing\",\"verbs\":[\"POST\",\"GET\"]} |
13
+ **organization_id** | **String** | {\"default\":\"(Auto-populated using your authentication credentials) ID of the organization actioning this request.\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional]
14
+
15
+
data/docs/Subscription.md CHANGED
@@ -42,6 +42,7 @@ Name | Type | Description | Notes
42
42
  **current_time** | **DateTime** | {\"description\":\"The current time — from the point of view of the subscription.\",\"verbs\":[\"GET\"]} |
43
43
  **time_offset** | **Integer** | {\"description\":\"How far in the future is the entity (in seconds) compared to the BillForward server's time.\",\"verbs\":[\"GET\"]} | [optional]
44
44
  **payment_terms** | **Integer** | | [optional]
45
+ **purchase_order** | **String** | { \"default\": \" \", \"description\":\"Purchase order associated with the subscription. If specified this is copied to any invoices issued for this subscription.\",\"verbs\":[\"POST\"]} | [optional]
45
46
  **failed_payment_behaviour** | **String** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional]
46
47
 
47
48
 
@@ -51,6 +51,7 @@ Method | HTTP request | Description
51
51
  [**revive_subscription**](SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state
52
52
  [**set_metadata_for_subscription**](SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data.
53
53
  [**set_pricing_component_value_on_subscription**](SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
54
+ [**set_pricing_component_value_on_subscription_batch_update**](SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
54
55
  [**set_pricing_component_value_on_subscription_v2**](SubscriptionsApi.md#set_pricing_component_value_on_subscription_v2) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | Upgrades/downgrades this subscription to some new value for the specified pricing-component.
55
56
  [**update_subscription**](SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription.
56
57
  [**update_subscription_v2**](SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2).
@@ -102,8 +103,8 @@ No authorization required
102
103
 
103
104
  ### HTTP request headers
104
105
 
105
- - **Content-Type**: application/json
106
- - **Accept**: application/json
106
+ - **Content-Type**: application/json; charset=utf-8
107
+ - **Accept**: application/json; charset=utf-8
107
108
 
108
109
 
109
110
 
@@ -152,8 +153,8 @@ No authorization required
152
153
 
153
154
  ### HTTP request headers
154
155
 
155
- - **Content-Type**: application/json
156
- - **Accept**: application/json
156
+ - **Content-Type**: application/json; charset=utf-8
157
+ - **Accept**: application/json; charset=utf-8
157
158
 
158
159
 
159
160
 
@@ -202,8 +203,8 @@ No authorization required
202
203
 
203
204
  ### HTTP request headers
204
205
 
205
- - **Content-Type**: application/json
206
- - **Accept**: application/json
206
+ - **Content-Type**: application/json; charset=utf-8
207
+ - **Accept**: application/json; charset=utf-8
207
208
 
208
209
 
209
210
 
@@ -252,8 +253,8 @@ No authorization required
252
253
 
253
254
  ### HTTP request headers
254
255
 
255
- - **Content-Type**: application/json
256
- - **Accept**: application/json
256
+ - **Content-Type**: application/json; charset=utf-8
257
+ - **Accept**: application/json; charset=utf-8
257
258
 
258
259
 
259
260
 
@@ -302,8 +303,8 @@ No authorization required
302
303
 
303
304
  ### HTTP request headers
304
305
 
305
- - **Content-Type**: application/json
306
- - **Accept**: application/json
306
+ - **Content-Type**: application/json; charset=utf-8
307
+ - **Accept**: application/json; charset=utf-8
307
308
 
308
309
 
309
310
 
@@ -361,8 +362,8 @@ No authorization required
361
362
 
362
363
  ### HTTP request headers
363
364
 
364
- - **Content-Type**: text/plain, application/json
365
- - **Accept**: application/json
365
+ - **Content-Type**: text/plain, application/json; charset=utf-8
366
+ - **Accept**: application/json; charset=utf-8
366
367
 
367
368
 
368
369
 
@@ -408,8 +409,8 @@ No authorization required
408
409
 
409
410
  ### HTTP request headers
410
411
 
411
- - **Content-Type**: application/json
412
- - **Accept**: application/json
412
+ - **Content-Type**: application/json; charset=utf-8
413
+ - **Accept**: application/json; charset=utf-8
413
414
 
414
415
 
415
416
 
@@ -458,8 +459,8 @@ No authorization required
458
459
 
459
460
  ### HTTP request headers
460
461
 
461
- - **Content-Type**: application/json
462
- - **Accept**: application/json
462
+ - **Content-Type**: application/json; charset=utf-8
463
+ - **Accept**: application/json; charset=utf-8
463
464
 
464
465
 
465
466
 
@@ -505,8 +506,8 @@ No authorization required
505
506
 
506
507
  ### HTTP request headers
507
508
 
508
- - **Content-Type**: application/json
509
- - **Accept**: application/json
509
+ - **Content-Type**: application/json; charset=utf-8
510
+ - **Accept**: application/json; charset=utf-8
510
511
 
511
512
 
512
513
 
@@ -552,8 +553,8 @@ No authorization required
552
553
 
553
554
  ### HTTP request headers
554
555
 
555
- - **Content-Type**: application/json
556
- - **Accept**: text/xml, application/xml, application/json
556
+ - **Content-Type**: application/json; charset=utf-8
557
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
557
558
 
558
559
 
559
560
 
@@ -599,8 +600,8 @@ No authorization required
599
600
 
600
601
  ### HTTP request headers
601
602
 
602
- - **Content-Type**: application/json
603
- - **Accept**: application/json
603
+ - **Content-Type**: application/json; charset=utf-8
604
+ - **Accept**: application/json; charset=utf-8
604
605
 
605
606
 
606
607
 
@@ -649,8 +650,8 @@ No authorization required
649
650
 
650
651
  ### HTTP request headers
651
652
 
652
- - **Content-Type**: application/json
653
- - **Accept**: application/json
653
+ - **Content-Type**: application/json; charset=utf-8
654
+ - **Accept**: application/json; charset=utf-8
654
655
 
655
656
 
656
657
 
@@ -700,8 +701,8 @@ No authorization required
700
701
 
701
702
  ### HTTP request headers
702
703
 
703
- - **Content-Type**: text/plain, application/json
704
- - **Accept**: application/json
704
+ - **Content-Type**: text/plain, application/json; charset=utf-8
705
+ - **Accept**: application/json; charset=utf-8
705
706
 
706
707
 
707
708
 
@@ -750,8 +751,8 @@ No authorization required
750
751
 
751
752
  ### HTTP request headers
752
753
 
753
- - **Content-Type**: application/json
754
- - **Accept**: application/json
754
+ - **Content-Type**: application/json; charset=utf-8
755
+ - **Accept**: application/json; charset=utf-8
755
756
 
756
757
 
757
758
 
@@ -816,8 +817,8 @@ No authorization required
816
817
 
817
818
  ### HTTP request headers
818
819
 
819
- - **Content-Type**: text/plain, application/json
820
- - **Accept**: application/json
820
+ - **Content-Type**: text/plain, application/json; charset=utf-8
821
+ - **Accept**: application/json; charset=utf-8
821
822
 
822
823
 
823
824
 
@@ -877,8 +878,8 @@ No authorization required
877
878
 
878
879
  ### HTTP request headers
879
880
 
880
- - **Content-Type**: text/plain, application/json
881
- - **Accept**: application/json
881
+ - **Content-Type**: text/plain, application/json; charset=utf-8
882
+ - **Accept**: application/json; charset=utf-8
882
883
 
883
884
 
884
885
 
@@ -938,8 +939,8 @@ No authorization required
938
939
 
939
940
  ### HTTP request headers
940
941
 
941
- - **Content-Type**: text/plain, application/json
942
- - **Accept**: application/json
942
+ - **Content-Type**: text/plain, application/json; charset=utf-8
943
+ - **Accept**: application/json; charset=utf-8
943
944
 
944
945
 
945
946
 
@@ -1003,8 +1004,8 @@ No authorization required
1003
1004
 
1004
1005
  ### HTTP request headers
1005
1006
 
1006
- - **Content-Type**: text/plain, application/json
1007
- - **Accept**: application/json
1007
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1008
+ - **Accept**: application/json; charset=utf-8
1008
1009
 
1009
1010
 
1010
1011
 
@@ -1064,8 +1065,8 @@ No authorization required
1064
1065
 
1065
1066
  ### HTTP request headers
1066
1067
 
1067
- - **Content-Type**: text/plain, application/json
1068
- - **Accept**: application/json
1068
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1069
+ - **Accept**: application/json; charset=utf-8
1069
1070
 
1070
1071
 
1071
1072
 
@@ -1125,8 +1126,8 @@ No authorization required
1125
1126
 
1126
1127
  ### HTTP request headers
1127
1128
 
1128
- - **Content-Type**: text/plain, application/json
1129
- - **Accept**: application/json
1129
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1130
+ - **Accept**: application/json; charset=utf-8
1130
1131
 
1131
1132
 
1132
1133
 
@@ -1187,8 +1188,8 @@ No authorization required
1187
1188
 
1188
1189
  ### HTTP request headers
1189
1190
 
1190
- - **Content-Type**: text/plain, application/json
1191
- - **Accept**: application/json
1191
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1192
+ - **Accept**: application/json; charset=utf-8
1192
1193
 
1193
1194
 
1194
1195
 
@@ -1238,8 +1239,8 @@ No authorization required
1238
1239
 
1239
1240
  ### HTTP request headers
1240
1241
 
1241
- - **Content-Type**: text/plain, application/json
1242
- - **Accept**: application/json
1242
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1243
+ - **Accept**: application/json; charset=utf-8
1243
1244
 
1244
1245
 
1245
1246
 
@@ -1289,8 +1290,8 @@ No authorization required
1289
1290
 
1290
1291
  ### HTTP request headers
1291
1292
 
1292
- - **Content-Type**: text/plain, application/json
1293
- - **Accept**: application/json
1293
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1294
+ - **Accept**: application/json; charset=utf-8
1294
1295
 
1295
1296
 
1296
1297
 
@@ -1336,8 +1337,8 @@ No authorization required
1336
1337
 
1337
1338
  ### HTTP request headers
1338
1339
 
1339
- - **Content-Type**: text/plain, application/json
1340
- - **Accept**: application/json
1340
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1341
+ - **Accept**: application/json; charset=utf-8
1341
1342
 
1342
1343
 
1343
1344
 
@@ -1399,8 +1400,8 @@ No authorization required
1399
1400
 
1400
1401
  ### HTTP request headers
1401
1402
 
1402
- - **Content-Type**: text/plain, application/json
1403
- - **Accept**: application/json
1403
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1404
+ - **Accept**: application/json; charset=utf-8
1404
1405
 
1405
1406
 
1406
1407
 
@@ -1452,8 +1453,8 @@ No authorization required
1452
1453
 
1453
1454
  ### HTTP request headers
1454
1455
 
1455
- - **Content-Type**: text/plain, application/json
1456
- - **Accept**: application/json
1456
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1457
+ - **Accept**: application/json; charset=utf-8
1457
1458
 
1458
1459
 
1459
1460
 
@@ -1515,8 +1516,8 @@ No authorization required
1515
1516
 
1516
1517
  ### HTTP request headers
1517
1518
 
1518
- - **Content-Type**: text/plain, application/json
1519
- - **Accept**: application/json
1519
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1520
+ - **Accept**: application/json; charset=utf-8
1520
1521
 
1521
1522
 
1522
1523
 
@@ -1578,8 +1579,8 @@ No authorization required
1578
1579
 
1579
1580
  ### HTTP request headers
1580
1581
 
1581
- - **Content-Type**: text/plain, application/json
1582
- - **Accept**: application/json
1582
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1583
+ - **Accept**: application/json; charset=utf-8
1583
1584
 
1584
1585
 
1585
1586
 
@@ -1641,8 +1642,8 @@ No authorization required
1641
1642
 
1642
1643
  ### HTTP request headers
1643
1644
 
1644
- - **Content-Type**: text/plain, application/json
1645
- - **Accept**: application/json
1645
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1646
+ - **Accept**: application/json; charset=utf-8
1646
1647
 
1647
1648
 
1648
1649
 
@@ -1692,8 +1693,8 @@ No authorization required
1692
1693
 
1693
1694
  ### HTTP request headers
1694
1695
 
1695
- - **Content-Type**: text/plain, application/json
1696
- - **Accept**: application/json
1696
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1697
+ - **Accept**: application/json; charset=utf-8
1697
1698
 
1698
1699
 
1699
1700
 
@@ -1754,8 +1755,8 @@ No authorization required
1754
1755
 
1755
1756
  ### HTTP request headers
1756
1757
 
1757
- - **Content-Type**: text/plain, application/json
1758
- - **Accept**: application/json
1758
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1759
+ - **Accept**: application/json; charset=utf-8
1759
1760
 
1760
1761
 
1761
1762
 
@@ -1816,8 +1817,8 @@ No authorization required
1816
1817
 
1817
1818
  ### HTTP request headers
1818
1819
 
1819
- - **Content-Type**: text/plain, application/json
1820
- - **Accept**: application/json
1820
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1821
+ - **Accept**: application/json; charset=utf-8
1821
1822
 
1822
1823
 
1823
1824
 
@@ -1878,8 +1879,8 @@ No authorization required
1878
1879
 
1879
1880
  ### HTTP request headers
1880
1881
 
1881
- - **Content-Type**: text/plain, application/json
1882
- - **Accept**: application/json
1882
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1883
+ - **Accept**: application/json; charset=utf-8
1883
1884
 
1884
1885
 
1885
1886
 
@@ -1940,8 +1941,8 @@ No authorization required
1940
1941
 
1941
1942
  ### HTTP request headers
1942
1943
 
1943
- - **Content-Type**: text/plain, application/json
1944
- - **Accept**: application/json
1944
+ - **Content-Type**: text/plain, application/json; charset=utf-8
1945
+ - **Accept**: application/json; charset=utf-8
1945
1946
 
1946
1947
 
1947
1948
 
@@ -2001,8 +2002,8 @@ No authorization required
2001
2002
 
2002
2003
  ### HTTP request headers
2003
2004
 
2004
- - **Content-Type**: text/plain, application/json
2005
- - **Accept**: application/json
2005
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2006
+ - **Accept**: application/json; charset=utf-8
2006
2007
 
2007
2008
 
2008
2009
 
@@ -2066,8 +2067,8 @@ No authorization required
2066
2067
 
2067
2068
  ### HTTP request headers
2068
2069
 
2069
- - **Content-Type**: text/plain, application/json
2070
- - **Accept**: application/json
2070
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2071
+ - **Accept**: application/json; charset=utf-8
2071
2072
 
2072
2073
 
2073
2074
 
@@ -2113,8 +2114,8 @@ No authorization required
2113
2114
 
2114
2115
  ### HTTP request headers
2115
2116
 
2116
- - **Content-Type**: application/json
2117
- - **Accept**: application/json
2117
+ - **Content-Type**: application/json; charset=utf-8
2118
+ - **Accept**: application/json; charset=utf-8
2118
2119
 
2119
2120
 
2120
2121
 
@@ -2163,8 +2164,8 @@ No authorization required
2163
2164
 
2164
2165
  ### HTTP request headers
2165
2166
 
2166
- - **Content-Type**: application/json
2167
- - **Accept**: application/json
2167
+ - **Content-Type**: application/json; charset=utf-8
2168
+ - **Accept**: application/json; charset=utf-8
2168
2169
 
2169
2170
 
2170
2171
 
@@ -2213,8 +2214,8 @@ No authorization required
2213
2214
 
2214
2215
  ### HTTP request headers
2215
2216
 
2216
- - **Content-Type**: application/json
2217
- - **Accept**: application/json
2217
+ - **Content-Type**: application/json; charset=utf-8
2218
+ - **Accept**: application/json; charset=utf-8
2218
2219
 
2219
2220
 
2220
2221
 
@@ -2267,8 +2268,8 @@ No authorization required
2267
2268
 
2268
2269
  ### HTTP request headers
2269
2270
 
2270
- - **Content-Type**: text/plain, application/json
2271
- - **Accept**: application/json
2271
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2272
+ - **Accept**: application/json; charset=utf-8
2272
2273
 
2273
2274
 
2274
2275
 
@@ -2321,8 +2322,8 @@ No authorization required
2321
2322
 
2322
2323
  ### HTTP request headers
2323
2324
 
2324
- - **Content-Type**: text/plain, application/json
2325
- - **Accept**: application/json
2325
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2326
+ - **Accept**: application/json; charset=utf-8
2326
2327
 
2327
2328
 
2328
2329
 
@@ -2375,8 +2376,8 @@ No authorization required
2375
2376
 
2376
2377
  ### HTTP request headers
2377
2378
 
2378
- - **Content-Type**: text/plain, application/json
2379
- - **Accept**: application/json
2379
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2380
+ - **Accept**: application/json; charset=utf-8
2380
2381
 
2381
2382
 
2382
2383
 
@@ -2429,8 +2430,8 @@ No authorization required
2429
2430
 
2430
2431
  ### HTTP request headers
2431
2432
 
2432
- - **Content-Type**: text/plain, application/json
2433
- - **Accept**: application/json
2433
+ - **Content-Type**: text/plain, application/json; charset=utf-8
2434
+ - **Accept**: application/json; charset=utf-8
2434
2435
 
2435
2436
 
2436
2437
 
@@ -2479,8 +2480,8 @@ No authorization required
2479
2480
 
2480
2481
  ### HTTP request headers
2481
2482
 
2482
- - **Content-Type**: application/json
2483
- - **Accept**: application/json
2483
+ - **Content-Type**: application/json; charset=utf-8
2484
+ - **Accept**: application/json; charset=utf-8
2484
2485
 
2485
2486
 
2486
2487
 
@@ -2529,8 +2530,8 @@ No authorization required
2529
2530
 
2530
2531
  ### HTTP request headers
2531
2532
 
2532
- - **Content-Type**: application/json
2533
- - **Accept**: application/json
2533
+ - **Content-Type**: application/json; charset=utf-8
2534
+ - **Accept**: application/json; charset=utf-8
2534
2535
 
2535
2536
 
2536
2537
 
@@ -2583,8 +2584,8 @@ No authorization required
2583
2584
 
2584
2585
  ### HTTP request headers
2585
2586
 
2586
- - **Content-Type**: application/json
2587
- - **Accept**: application/json
2587
+ - **Content-Type**: application/json; charset=utf-8
2588
+ - **Accept**: application/json; charset=utf-8
2588
2589
 
2589
2590
 
2590
2591
 
@@ -2633,8 +2634,58 @@ No authorization required
2633
2634
 
2634
2635
  ### HTTP request headers
2635
2636
 
2636
- - **Content-Type**: application/json
2637
- - **Accept**: application/json
2637
+ - **Content-Type**: application/json; charset=utf-8
2638
+ - **Accept**: application/json; charset=utf-8
2639
+
2640
+
2641
+
2642
+ # **set_pricing_component_value_on_subscription_batch_update**
2643
+ > UpdatePricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_batch_update(subscription_id, request)
2644
+
2645
+ Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
2646
+
2647
+ {\"nickname\":\"Set values\",\"request\":\"setBatchPricingComponentValueRequest.html\",\"response\":\"setBatchPricingComponentValue.html\"}
2648
+
2649
+ ### Example
2650
+ ```ruby
2651
+ # load the gem
2652
+ require 'bf_ruby2'
2653
+
2654
+ api_instance = BillForward::SubscriptionsApi.new
2655
+
2656
+ subscription_id = "subscription_id_example" # String | ID of the subscription
2657
+
2658
+ request = BillForward::BatchUpdatePricingComponentValuesRequest.new # BatchUpdatePricingComponentValuesRequest | The batched update requests.
2659
+
2660
+
2661
+ begin
2662
+ #Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
2663
+ result = api_instance.set_pricing_component_value_on_subscription_batch_update(subscription_id, request)
2664
+ p result
2665
+ rescue BillForward::ApiError => e
2666
+ puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_batch_update: #{e}"
2667
+ end
2668
+ ```
2669
+
2670
+ ### Parameters
2671
+
2672
+ Name | Type | Description | Notes
2673
+ ------------- | ------------- | ------------- | -------------
2674
+ **subscription_id** | **String**| ID of the subscription |
2675
+ **request** | [**BatchUpdatePricingComponentValuesRequest**](BatchUpdatePricingComponentValuesRequest.md)| The batched update requests. |
2676
+
2677
+ ### Return type
2678
+
2679
+ [**UpdatePricingComponentValueResponsePagedMetadata**](UpdatePricingComponentValueResponsePagedMetadata.md)
2680
+
2681
+ ### Authorization
2682
+
2683
+ No authorization required
2684
+
2685
+ ### HTTP request headers
2686
+
2687
+ - **Content-Type**: application/json; charset=utf-8
2688
+ - **Accept**: application/json; charset=utf-8
2638
2689
 
2639
2690
 
2640
2691
 
@@ -2686,8 +2737,8 @@ No authorization required
2686
2737
 
2687
2738
  ### HTTP request headers
2688
2739
 
2689
- - **Content-Type**: application/json
2690
- - **Accept**: application/json
2740
+ - **Content-Type**: application/json; charset=utf-8
2741
+ - **Accept**: application/json; charset=utf-8
2691
2742
 
2692
2743
 
2693
2744
 
@@ -2733,8 +2784,8 @@ No authorization required
2733
2784
 
2734
2785
  ### HTTP request headers
2735
2786
 
2736
- - **Content-Type**: application/json
2737
- - **Accept**: text/xml, application/xml, application/json
2787
+ - **Content-Type**: application/json; charset=utf-8
2788
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
2738
2789
 
2739
2790
 
2740
2791
 
@@ -2780,8 +2831,8 @@ No authorization required
2780
2831
 
2781
2832
  ### HTTP request headers
2782
2833
 
2783
- - **Content-Type**: application/json
2784
- - **Accept**: application/json
2834
+ - **Content-Type**: application/json; charset=utf-8
2835
+ - **Accept**: application/json; charset=utf-8
2785
2836
 
2786
2837
 
2787
2838
 
@@ -2834,8 +2885,8 @@ No authorization required
2834
2885
 
2835
2886
  ### HTTP request headers
2836
2887
 
2837
- - **Content-Type**: application/json
2838
- - **Accept**: application/json
2888
+ - **Content-Type**: application/json; charset=utf-8
2889
+ - **Accept**: application/json; charset=utf-8
2839
2890
 
2840
2891
 
2841
2892