chargebee 2.50.0 → 2.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/CHANGELOG.md +92 -0
  2. package/lib/chargebee.js +1 -1
  3. package/lib/resources/api_endpoints.js +37 -1
  4. package/package.json +1 -1
  5. package/types/core.d.ts +8 -5
  6. package/types/index.d.ts +3 -0
  7. package/types/resources/Address.d.ts +2 -194
  8. package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
  9. package/types/resources/Attribute.d.ts +4 -1
  10. package/types/resources/BillingConfiguration.d.ts +21 -0
  11. package/types/resources/Brand.d.ts +12 -0
  12. package/types/resources/BusinessEntity.d.ts +8 -6
  13. package/types/resources/BusinessEntityTransfer.d.ts +10 -7
  14. package/types/resources/Card.d.ts +11 -311
  15. package/types/resources/Comment.d.ts +7 -124
  16. package/types/resources/Configuration.d.ts +2 -0
  17. package/types/resources/Contact.d.ts +2 -44
  18. package/types/resources/ContractTerm.d.ts +4 -72
  19. package/types/resources/Coupon.d.ts +0 -37
  20. package/types/resources/CouponCode.d.ts +67 -35
  21. package/types/resources/CouponSet.d.ts +12 -121
  22. package/types/resources/CreditNote.d.ts +2 -6
  23. package/types/resources/CreditNoteEstimate.d.ts +1 -1
  24. package/types/resources/Currency.d.ts +8 -5
  25. package/types/resources/Customer.d.ts +90 -89
  26. package/types/resources/Discount.d.ts +2 -89
  27. package/types/resources/Download.d.ts +2 -14
  28. package/types/resources/Entitlement.d.ts +15 -103
  29. package/types/resources/EntitlementOverride.d.ts +4 -89
  30. package/types/resources/Estimate.d.ts +6 -10
  31. package/types/resources/Event.d.ts +23 -108
  32. package/types/resources/Export.d.ts +116 -432
  33. package/types/resources/Feature.d.ts +17 -319
  34. package/types/resources/GatewayErrorDetail.d.ts +6 -48
  35. package/types/resources/Gift.d.ts +34 -294
  36. package/types/resources/Hierarchy.d.ts +4 -24
  37. package/types/resources/ImpactedItem.d.ts +4 -36
  38. package/types/resources/ImpactedItemPrice.d.ts +5 -2
  39. package/types/resources/ImpactedSubscription.d.ts +3 -30
  40. package/types/resources/InAppSubscription.d.ts +13 -355
  41. package/types/resources/Invoice.d.ts +26 -18
  42. package/types/resources/InvoiceEstimate.d.ts +1 -1
  43. package/types/resources/Item.d.ts +4 -9
  44. package/types/resources/ItemEntitlement.d.ts +15 -155
  45. package/types/resources/NonSubscription.d.ts +9 -6
  46. package/types/resources/OmnichannelSubscriptionItem.d.ts +9 -0
  47. package/types/resources/PaymentIntent.d.ts +9 -255
  48. package/types/resources/PaymentReferenceNumber.d.ts +3 -20
  49. package/types/resources/PaymentSource.d.ts +2 -2
  50. package/types/resources/PaymentVoucher.d.ts +20 -203
  51. package/types/resources/PortalSession.d.ts +4 -146
  52. package/types/resources/PromotionalCredit.d.ts +10 -215
  53. package/types/resources/Purchase.d.ts +3 -1
  54. package/types/resources/Quote.d.ts +68 -18
  55. package/types/resources/QuoteLineGroup.d.ts +1 -1
  56. package/types/resources/QuotedRamp.d.ts +142 -0
  57. package/types/resources/RecordedPurchase.d.ts +2 -0
  58. package/types/resources/ResourceMigration.d.ts +2 -54
  59. package/types/resources/SiteMigrationDetail.d.ts +13 -55
  60. package/types/resources/Subscription.d.ts +13 -9
  61. package/types/resources/SubscriptionEntitlement.d.ts +6 -106
  62. package/types/resources/SubscriptionEstimate.d.ts +14 -11
  63. package/types/resources/TaxWithheld.d.ts +14 -26
  64. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
  65. package/types/resources/TimeMachine.d.ts +3 -64
  66. package/types/resources/Token.d.ts +3 -60
  67. package/types/resources/Transaction.d.ts +2 -2
  68. package/types/resources/Usage.d.ts +21 -165
@@ -1,134 +1,44 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface PromotionalCredit {
4
5
 
5
- /**
6
- * @description Unique reference ID provided for promotional credits
7
6
 
8
- */
9
-
10
7
  id:string;
11
-
12
- /**
13
- * @description Identifier of the customer.
14
8
 
15
- */
16
-
17
9
  customer_id:string;
18
-
19
- /**
20
- * @description Type of promotional credits \* decrement - Decrement \* increment - Increment
21
10
 
22
- */
23
-
24
- type:'decrement' | 'increment';
25
-
26
- /**
27
- * @description Amount in decimal
11
+ type:'increment' | 'decrement';
28
12
 
29
- */
30
-
31
13
  amount_in_decimal?:string;
32
-
33
- /**
34
- * @description Promotional credits amount
35
14
 
36
- */
37
-
38
15
  amount:number;
39
-
40
- /**
41
- * @description The currency code (ISO 4217 format) for promotional credit
42
16
 
43
- */
44
-
45
17
  currency_code:string;
46
-
47
- /**
48
- * @description Detailed description of this promotional credits.
49
18
 
50
- */
51
-
52
19
  description:string;
53
-
54
- /**
55
- * @description Type of promotional credits provided to customer \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits \* general - General
56
20
 
57
- */
58
-
59
21
  credit_type:CreditType;
60
-
61
- /**
62
- * @description Describes why promotional credits were provided
63
22
 
64
- */
65
-
66
23
  reference?:string;
67
-
68
- /**
69
- * @description Closing balance as on end date.
70
24
 
71
- */
72
-
73
25
  closing_balance:number;
74
-
75
- /**
76
- * @description The user who added/deducted the credit. If created via API, this contains the name given for the API key used.
77
26
 
78
- */
79
-
80
27
  done_by?:string;
81
-
82
- /**
83
- * @description Timestamp indicating when this promotional credit resource is created.
84
28
 
85
- */
86
-
87
29
  created_at:number;
30
+
88
31
  }
89
32
  export namespace PromotionalCredit {
90
33
  export class PromotionalCreditResource {
91
- /**
92
- * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
93
-
94
- For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
95
-
96
- */
97
-
98
34
  add(input:AddInputParam):ChargebeeRequest<AddResponse>;
99
35
 
100
- /**
101
- * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
102
-
103
- For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer&#x27;s credit balance would become $15.
104
-
105
- If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
106
-
107
- */
108
-
109
36
  deduct(input:DeductInputParam):ChargebeeRequest<DeductResponse>;
110
37
 
111
- /**
112
- * @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
113
-
114
- For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
115
-
116
- */
117
-
118
38
  set(input:SetInputParam):ChargebeeRequest<SetResponse>;
119
39
 
120
- /**
121
- * @description This endpoint lists the promotional credits set for a customer
122
-
123
- */
124
-
125
40
  list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
126
41
 
127
- /**
128
- * @description This endpoint retrieves the promotional credit based on the promotional credit id
129
-
130
- */
131
-
132
42
  retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
133
43
  }
134
44
  export interface AddResponse {
@@ -138,53 +48,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
138
48
  }
139
49
  export interface AddInputParam {
140
50
 
141
- /**
142
- * @description Identifier of the customer.
143
-
144
- */
145
-
146
51
  customer_id:string;
147
52
 
148
- /**
149
- * @description Promotional credits amount.
150
-
151
- */
152
-
153
53
  amount?:number;
154
54
 
155
- /**
156
- * @description Amount in decimal.
157
-
158
- */
159
-
160
55
  amount_in_decimal?:string;
161
56
 
162
- /**
163
- * @description The currency code (ISO 4217 format) for promotional credit.
164
-
165
- */
166
-
167
57
  currency_code?:string;
168
58
 
169
- /**
170
- * @description Detailed description of this promotional credits.
171
-
172
- */
173
-
174
59
  description:string;
175
60
 
176
- /**
177
- * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
178
-
179
- */
180
-
181
61
  credit_type?:CreditType;
182
62
 
183
- /**
184
- * @description Describes why promotional credits were provided.
185
-
186
- */
187
-
188
63
  reference?:string;
189
64
  }
190
65
  export interface DeductResponse {
@@ -194,53 +69,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
194
69
  }
195
70
  export interface DeductInputParam {
196
71
 
197
- /**
198
- * @description Identifier of the customer.
199
-
200
- */
201
-
202
72
  customer_id:string;
203
73
 
204
- /**
205
- * @description Promotional credits amount.
206
-
207
- */
208
-
209
74
  amount?:number;
210
75
 
211
- /**
212
- * @description Amount in decimal.
213
-
214
- */
215
-
216
76
  amount_in_decimal?:string;
217
77
 
218
- /**
219
- * @description The currency code (ISO 4217 format) for promotional credit.
220
-
221
- */
222
-
223
78
  currency_code?:string;
224
79
 
225
- /**
226
- * @description Detailed description of this promotional credits.
227
-
228
- */
229
-
230
80
  description:string;
231
81
 
232
- /**
233
- * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
234
-
235
- */
236
-
237
82
  credit_type?:CreditType;
238
83
 
239
- /**
240
- * @description Describes why promotional credits were provided.
241
-
242
- */
243
-
244
84
  reference?:string;
245
85
  }
246
86
  export interface SetResponse {
@@ -250,109 +90,64 @@ For example, if a customer has a credit balance of $10 and if you would like to
250
90
  }
251
91
  export interface SetInputParam {
252
92
 
253
- /**
254
- * @description Identifier of the customer.
255
-
256
- */
257
-
258
93
  customer_id:string;
259
94
 
260
- /**
261
- * @description Promotional credits amount.
262
-
263
- */
264
-
265
95
  amount?:number;
266
96
 
267
- /**
268
- * @description Amount in decimal.
269
-
270
- */
271
-
272
97
  amount_in_decimal?:string;
273
98
 
274
- /**
275
- * @description The currency code (ISO 4217 format) for promotional credit.
276
-
277
- */
278
-
279
99
  currency_code?:string;
280
100
 
281
- /**
282
- * @description Detailed description of this promotional credits.
283
-
284
- */
285
-
286
101
  description:string;
287
102
 
288
- /**
289
- * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
290
-
291
- */
292
-
293
103
  credit_type?:CreditType;
294
104
 
295
- /**
296
- * @description Describes why promotional credits were provided.
297
-
298
- */
299
-
300
105
  reference?:string;
301
106
  }
302
107
  export interface ListResponse {
303
- /**
304
- * @description This endpoint lists the promotional credits set for a customer
305
-
306
- */
307
-
308
108
  list:{promotional_credit:PromotionalCredit}[];
309
109
 
310
- /**
311
- * @description This endpoint lists the promotional credits set for a customer
312
-
313
- */
314
-
315
110
  next_offset?:string;
316
111
  }
317
112
  export interface ListInputParam {
318
113
  [key : string]: any;
319
114
  /**
320
- * @description This endpoint lists the promotional credits set for a customer
115
+ * @description The number of resources to be returned.
321
116
 
322
117
  */
323
118
 
324
119
  limit?:number;
325
120
 
326
121
  /**
327
- * @description This endpoint lists the promotional credits set for a customer
122
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
328
123
 
329
124
  */
330
125
 
331
126
  offset?:string;
332
127
 
333
128
  /**
334
- * @description This endpoint lists the promotional credits set for a customer
129
+ * @description Unique reference ID provided for promotional credits
335
130
 
336
131
  */
337
132
 
338
133
  id?:{is?:string,is_not?:string,starts_with?:string};
339
134
 
340
135
  /**
341
- * @description This endpoint lists the promotional credits set for a customer
136
+ * @description Timestamp indicating when this promotional credit resource is created.
342
137
 
343
138
  */
344
139
 
345
140
  created_at?:{after?:string,before?:string,between?:string,on?:string};
346
141
 
347
142
  /**
348
- * @description This endpoint lists the promotional credits set for a customer
143
+ * @description Type of promotional credits
349
144
 
350
145
  */
351
146
 
352
- type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
147
+ type?:{in?:string,is?:'increment' | 'decrement',is_not?:'increment' | 'decrement',not_in?:string};
353
148
 
354
149
  /**
355
- * @description This endpoint lists the promotional credits set for a customer
150
+ * @description Identifier of the customer.
356
151
 
357
152
  */
358
153
 
@@ -34,7 +34,7 @@ declare module 'chargebee' {
34
34
 
35
35
  statement_descriptor?:{descriptor?:string};
36
36
 
37
- payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
37
+ payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
38
38
 
39
39
  purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
40
40
 
@@ -51,6 +51,8 @@ declare module 'chargebee' {
51
51
  customer_id:string;
52
52
 
53
53
  payment_source_id?:string;
54
+
55
+ replace_primary_payment_source?:boolean;
54
56
  }
55
57
  export interface EstimateResponse {
56
58
  estimate:Estimate;
@@ -16,9 +16,9 @@ declare module 'chargebee' {
16
16
 
17
17
  invoice_id?:string;
18
18
 
19
- status:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed';
19
+ status:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired';
20
20
 
21
- operation_type:'create_subscription_for_customer' | 'change_subscription' | 'onetime_invoice';
21
+ operation_type:'create_subscription_for_customer' | 'change_subscription' | 'onetime_invoice' | 'renew_subscription';
22
22
 
23
23
  vat_number?:string;
24
24
 
@@ -82,6 +82,10 @@ declare module 'chargebee' {
82
82
 
83
83
  deleted:boolean;
84
84
 
85
+ total_contract_value?:number;
86
+
87
+ total_discount?:number;
88
+
85
89
  }
86
90
  export namespace Quote {
87
91
  export class QuoteResource {
@@ -131,6 +135,8 @@ declare module 'chargebee' {
131
135
  quoted_subscription?:QuotedSubscription;
132
136
 
133
137
  quoted_charge?:QuotedCharge;
138
+
139
+ quoted_ramp?:QuotedRamp;
134
140
  }
135
141
 
136
142
  export interface CreateSubForCustomerQuoteResponse {
@@ -359,6 +365,8 @@ declare module 'chargebee' {
359
365
  quote:Quote;
360
366
 
361
367
  quoted_subscription?:QuotedSubscription;
368
+
369
+ quoted_ramp?:QuotedRamp;
362
370
  }
363
371
  export interface CreateSubItemsForCustomerQuoteInputParam {
364
372
  [key : string] : any;
@@ -368,11 +376,15 @@ declare module 'chargebee' {
368
376
 
369
377
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
370
378
 
371
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
379
+ billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
372
380
 
373
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
381
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
374
382
 
375
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
383
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
384
+
385
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
386
+
387
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
376
388
 
377
389
  name?:string;
378
390
 
@@ -389,11 +401,17 @@ declare module 'chargebee' {
389
401
  billing_alignment_mode?:BillingAlignmentMode;
390
402
 
391
403
  coupon_ids?:string[];
404
+
405
+ billing_start_option?:BillingStartOption;
406
+
407
+ net_term_days?:number;
392
408
  }
393
409
  export interface EditCreateSubCustomerQuoteForItemsResponse {
394
410
  quote:Quote;
395
411
 
396
412
  quoted_subscription?:QuotedSubscription;
413
+
414
+ quoted_ramp?:QuotedRamp;
397
415
  }
398
416
  export interface EditCreateSubCustomerQuoteForItemsInputParam {
399
417
  [key : string] : any;
@@ -403,11 +421,15 @@ declare module 'chargebee' {
403
421
 
404
422
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
405
423
 
406
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
424
+ billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
407
425
 
408
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
426
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
409
427
 
410
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
428
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
429
+
430
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
431
+
432
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
411
433
 
412
434
  notes?:string;
413
435
 
@@ -422,11 +444,17 @@ declare module 'chargebee' {
422
444
  billing_alignment_mode?:BillingAlignmentMode;
423
445
 
424
446
  coupon_ids?:string[];
447
+
448
+ billing_start_option?:BillingStartOption;
449
+
450
+ net_term_days?:number;
425
451
  }
426
452
  export interface UpdateSubscriptionQuoteForItemsResponse {
427
453
  quote:Quote;
428
454
 
429
455
  quoted_subscription?:QuotedSubscription;
456
+
457
+ quoted_ramp?:QuotedRamp;
430
458
  }
431
459
  export interface UpdateSubscriptionQuoteForItemsInputParam {
432
460
  [key : string] : any;
@@ -440,11 +468,13 @@ declare module 'chargebee' {
440
468
 
441
469
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
442
470
 
443
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
471
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
444
472
 
445
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
473
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
446
474
 
447
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
475
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
476
+
477
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
448
478
 
449
479
  name?:string;
450
480
 
@@ -475,11 +505,15 @@ declare module 'chargebee' {
475
505
  force_term_reset?:boolean;
476
506
 
477
507
  reactivate?:boolean;
508
+
509
+ net_term_days?:number;
478
510
  }
479
511
  export interface EditUpdateSubscriptionQuoteForItemsResponse {
480
512
  quote:Quote;
481
513
 
482
514
  quoted_subscription?:QuotedSubscription;
515
+
516
+ quoted_ramp?:QuotedRamp;
483
517
  }
484
518
  export interface EditUpdateSubscriptionQuoteForItemsInputParam {
485
519
  [key : string] : any;
@@ -493,11 +527,13 @@ declare module 'chargebee' {
493
527
 
494
528
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
495
529
 
496
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
530
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
497
531
 
498
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
532
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
499
533
 
500
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
534
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
535
+
536
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
501
537
 
502
538
  notes?:string;
503
539
 
@@ -526,6 +562,8 @@ declare module 'chargebee' {
526
562
  force_term_reset?:boolean;
527
563
 
528
564
  reactivate?:boolean;
565
+
566
+ net_term_days?:number;
529
567
  }
530
568
  export interface CreateForChargeItemsAndChargesResponse {
531
569
  quote:Quote;
@@ -534,6 +572,8 @@ declare module 'chargebee' {
534
572
  }
535
573
  export interface CreateForChargeItemsAndChargesInputParam {
536
574
 
575
+ billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
576
+
537
577
  shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
538
578
 
539
579
  item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
@@ -569,6 +609,8 @@ declare module 'chargebee' {
569
609
  }
570
610
  export interface EditForChargeItemsAndChargesInputParam {
571
611
 
612
+ billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
613
+
572
614
  shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
573
615
 
574
616
  item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
@@ -594,7 +636,7 @@ declare module 'chargebee' {
594
636
  coupon_ids?:string[];
595
637
  }
596
638
  export interface ListResponse {
597
- list:{quote:Quote,quoted_subscription?:QuotedSubscription}[];
639
+ list:{quote:Quote,quoted_subscription?:QuotedSubscription,quoted_ramp?:QuotedRamp}[];
598
640
 
599
641
  next_offset?:string;
600
642
  }
@@ -648,7 +690,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
648
690
 
649
691
  */
650
692
 
651
- status?:{in?:string,is?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',is_not?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',not_in?:string};
693
+ status?:{in?:string,is?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired',is_not?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired',not_in?:string};
652
694
 
653
695
  /**
654
696
  * @description Creation date of the quote. Typically this is the date on which quote is generated.
@@ -694,6 +736,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
694
736
 
695
737
  quoted_charge?:QuotedCharge;
696
738
 
739
+ quoted_ramp?:QuotedRamp;
740
+
697
741
  customer:Customer;
698
742
 
699
743
  subscription?:Subscription;
@@ -722,10 +766,12 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
722
766
  quoted_subscription?:QuotedSubscription;
723
767
 
724
768
  quoted_charge?:QuotedCharge;
769
+
770
+ quoted_ramp?:QuotedRamp;
725
771
  }
726
772
  export interface UpdateStatusInputParam {
727
773
 
728
- status:'accepted' | 'declined' | 'closed';
774
+ status:'accepted' | 'declined' | 'proposed' | 'voided' | 'closed';
729
775
 
730
776
  comment?:string;
731
777
  }
@@ -735,6 +781,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
735
781
  quoted_subscription?:QuotedSubscription;
736
782
 
737
783
  quoted_charge?:QuotedCharge;
784
+
785
+ quoted_ramp?:QuotedRamp;
738
786
  }
739
787
  export interface ExtendExpiryDateInputParam {
740
788
 
@@ -746,6 +794,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
746
794
  quoted_subscription?:QuotedSubscription;
747
795
 
748
796
  quoted_charge?:QuotedCharge;
797
+
798
+ quoted_ramp?:QuotedRamp;
749
799
  }
750
800
  export interface DeleteInputParam {
751
801
 
@@ -795,7 +845,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
795
845
 
796
846
  metered?:boolean;
797
847
 
798
- percentage?:string;
848
+ is_percentage_pricing?:boolean;
799
849
 
800
850
  reference_line_item_id?:string;
801
851
 
@@ -71,7 +71,7 @@ declare module 'chargebee' {
71
71
 
72
72
  metered?:boolean;
73
73
 
74
- percentage?:string;
74
+ is_percentage_pricing?:boolean;
75
75
 
76
76
  reference_line_item_id?:string;
77
77