chargebee 2.52.0 → 2.53.1

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 (60) hide show
  1. package/.github/workflows/release.yml +34 -0
  2. package/CHANGELOG.md +63 -0
  3. package/lib/chargebee.js +1 -1
  4. package/lib/resources/api_endpoints.js +90 -5
  5. package/package.json +1 -1
  6. package/types/core.d.ts +2 -2
  7. package/types/index.d.ts +8 -0
  8. package/types/resources/Addon.d.ts +1 -1
  9. package/types/resources/AttachedItem.d.ts +1 -1
  10. package/types/resources/BusinessEntity.d.ts +1 -1
  11. package/types/resources/Comment.d.ts +4 -2
  12. package/types/resources/Coupon.d.ts +1 -1
  13. package/types/resources/CouponCode.d.ts +1 -1
  14. package/types/resources/CouponSet.d.ts +1 -1
  15. package/types/resources/CreditNote.d.ts +88 -88
  16. package/types/resources/Customer.d.ts +4 -4
  17. package/types/resources/CustomerEntitlement.d.ts +3 -1
  18. package/types/resources/DifferentialPrice.d.ts +1 -1
  19. package/types/resources/Discount.d.ts +3 -1
  20. package/types/resources/Entitlement.d.ts +1 -1
  21. package/types/resources/EntitlementOverride.d.ts +1 -1
  22. package/types/resources/Estimate.d.ts +4 -4
  23. package/types/resources/Event.d.ts +2 -2
  24. package/types/resources/Feature.d.ts +1 -1
  25. package/types/resources/Gift.d.ts +2 -2
  26. package/types/resources/HostedPage.d.ts +15 -15
  27. package/types/resources/ImpactedCustomer.d.ts +23 -0
  28. package/types/resources/Invoice.d.ts +109 -109
  29. package/types/resources/Item.d.ts +1 -1
  30. package/types/resources/ItemEntitlement.d.ts +2 -2
  31. package/types/resources/ItemFamily.d.ts +1 -1
  32. package/types/resources/ItemPrice.d.ts +3 -3
  33. package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
  34. package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
  35. package/types/resources/OmnichannelSubscription.d.ts +2 -2
  36. package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
  37. package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
  38. package/types/resources/Order.d.ts +2 -2
  39. package/types/resources/PaymentSource.d.ts +1 -1
  40. package/types/resources/PaymentVoucher.d.ts +2 -2
  41. package/types/resources/Plan.d.ts +1 -1
  42. package/types/resources/PriceVariant.d.ts +1 -1
  43. package/types/resources/PricingPageSession.d.ts +5 -5
  44. package/types/resources/PromotionalCredit.d.ts +3 -1
  45. package/types/resources/Purchase.d.ts +2 -2
  46. package/types/resources/Quote.d.ts +8 -8
  47. package/types/resources/QuotedCharge.d.ts +7 -0
  48. package/types/resources/Ramp.d.ts +6 -6
  49. package/types/resources/RecordedPurchase.d.ts +6 -1
  50. package/types/resources/SiteMigrationDetail.d.ts +1 -1
  51. package/types/resources/Subscription.d.ts +14 -12
  52. package/types/resources/SubscriptionEntitlement.d.ts +1 -1
  53. package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
  54. package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
  55. package/types/resources/Transaction.d.ts +5 -5
  56. package/types/resources/UnbilledCharge.d.ts +1 -1
  57. package/types/resources/Usage.d.ts +1 -1
  58. package/types/resources/UsageFile.d.ts +5 -5
  59. package/types/resources/VirtualBankAccount.d.ts +1 -1
  60. package/types/resources/WebhookEndpoint.d.ts +117 -0
@@ -0,0 +1,90 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface OmnichannelOneTimeOrder {
5
+
6
+
7
+ id:string;
8
+
9
+ app_id:string;
10
+
11
+ customer_id?:string;
12
+
13
+ id_at_source:string;
14
+
15
+ origin?:string;
16
+
17
+ source:'apple_app_store' | 'google_play_store';
18
+
19
+ created_at:number;
20
+
21
+ resource_version?:number;
22
+
23
+ omnichannel_one_time_order_items:OmnichannelOneTimeOrderItem[];
24
+
25
+ purchase_transaction?:OmnichannelOneTimeOrder.OmnichannelTransaction;
26
+
27
+ }
28
+ export namespace OmnichannelOneTimeOrder {
29
+ export class OmnichannelOneTimeOrderResource {
30
+ retrieve(omnichannel_one_time_order_id:string):ChargebeeRequest<RetrieveResponse>;
31
+
32
+ list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
33
+ }
34
+ export interface RetrieveResponse {
35
+ omnichannel_one_time_order:OmnichannelOneTimeOrder;
36
+ }
37
+
38
+ export interface ListResponse {
39
+ list:{omnichannel_one_time_order:OmnichannelOneTimeOrder}[];
40
+
41
+ next_offset?:string;
42
+ }
43
+ export interface ListInputParam {
44
+ [key : string]: any;
45
+ /**
46
+ * @description The number of resources to be returned.
47
+
48
+ */
49
+
50
+ limit?:number;
51
+
52
+ /**
53
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
54
+
55
+ */
56
+
57
+ offset?:string;
58
+
59
+ source?:{in?:string,is?:'apple_app_store' | 'google_play_store',is_not?:'apple_app_store' | 'google_play_store',not_in?:string};
60
+
61
+ /**
62
+ * @description Chargebee Customer External Identifier
63
+
64
+ */
65
+
66
+ customer_id?:{is?:string,is_not?:string,starts_with?:string};
67
+ }
68
+ export interface OmnichannelTransaction {
69
+ id:string;
70
+
71
+ id_at_source:string;
72
+
73
+ app_id:string;
74
+
75
+ price_currency?:string;
76
+
77
+ price_units?:number;
78
+
79
+ price_nanos?:number;
80
+
81
+ type:'purchase' | 'renewal';
82
+
83
+ transacted_at?:number;
84
+
85
+ created_at:number;
86
+
87
+ resource_version?:number;
88
+ }
89
+ }
90
+ }
@@ -0,0 +1,24 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface OmnichannelOneTimeOrderItem {
5
+
6
+
7
+ id:string;
8
+
9
+ item_id_at_source:string;
10
+
11
+ item_type_at_source?:string;
12
+
13
+ quantity?:number;
14
+
15
+ cancelled_at?:number;
16
+
17
+ cancellation_reason?:'customer_cancelled' | 'customer_did_not_consent_to_price_increase' | 'refunded_due_to_app_issue' | 'refunded_for_other_reason' | 'merchant_revoked';
18
+
19
+ created_at:number;
20
+
21
+ resource_version?:number;
22
+
23
+ }
24
+ }
@@ -50,7 +50,7 @@ declare module 'chargebee' {
50
50
  limit?:number;
51
51
 
52
52
  /**
53
- * @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.
53
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
54
54
 
55
55
  */
56
56
 
@@ -80,7 +80,7 @@ declare module 'chargebee' {
80
80
  limit?:number;
81
81
 
82
82
  /**
83
- * @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.
83
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
84
84
 
85
85
  */
86
86
 
@@ -58,7 +58,7 @@ declare module 'chargebee' {
58
58
  limit?:number;
59
59
 
60
60
  /**
61
- * @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.
61
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
62
62
 
63
63
  */
64
64
 
@@ -10,7 +10,7 @@ declare module 'chargebee' {
10
10
 
11
11
  scheduled_at:number;
12
12
 
13
- change_type:'downgrade';
13
+ change_type:'downgrade' | 'pause';
14
14
 
15
15
  created_at:number;
16
16
 
@@ -316,7 +316,7 @@ declare module 'chargebee' {
316
316
  limit?:number;
317
317
 
318
318
  /**
319
- * @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.
319
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
320
320
 
321
321
  */
322
322
 
@@ -446,7 +446,7 @@ declare module 'chargebee' {
446
446
  limit?:number;
447
447
 
448
448
  /**
449
- * @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.
449
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
450
450
 
451
451
  */
452
452
 
@@ -258,7 +258,7 @@ declare module 'chargebee' {
258
258
  limit?:number;
259
259
 
260
260
  /**
261
- * @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.
261
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
262
262
 
263
263
  */
264
264
 
@@ -87,7 +87,7 @@ declare module 'chargebee' {
87
87
  limit?:number;
88
88
 
89
89
  /**
90
- * @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.
90
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
91
91
 
92
92
  */
93
93
 
@@ -117,7 +117,7 @@ declare module 'chargebee' {
117
117
  limit?:number;
118
118
 
119
119
  /**
120
- * @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.
120
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
121
121
 
122
122
  */
123
123
 
@@ -358,7 +358,7 @@ declare module 'chargebee' {
358
358
  limit?:number;
359
359
 
360
360
  /**
361
- * @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.
361
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
362
362
 
363
363
  */
364
364
 
@@ -102,7 +102,7 @@ declare module 'chargebee' {
102
102
  limit?:number;
103
103
 
104
104
  /**
105
- * @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.
105
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
106
106
 
107
107
  */
108
108
 
@@ -26,15 +26,15 @@ declare module 'chargebee' {
26
26
 
27
27
  pricing_page:{id:string};
28
28
 
29
- subscription?:object;
29
+ subscription?:{id?:string};
30
30
 
31
- customer?:object;
31
+ customer?:{company?:string,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string};
32
32
 
33
33
  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};
34
34
 
35
35
  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};
36
36
 
37
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
37
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
38
38
 
39
39
  redirect_url?:string;
40
40
 
@@ -47,9 +47,9 @@ declare module 'chargebee' {
47
47
 
48
48
  pricing_page:{id:string};
49
49
 
50
- subscription:object;
50
+ subscription:{id:string};
51
51
 
52
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
52
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
53
53
 
54
54
  redirect_url?:string;
55
55
  }
@@ -28,6 +28,8 @@ declare module 'chargebee' {
28
28
 
29
29
  created_at:number;
30
30
 
31
+ business_entity_id?:string;
32
+
31
33
  }
32
34
  export namespace PromotionalCredit {
33
35
  export class PromotionalCreditResource {
@@ -119,7 +121,7 @@ declare module 'chargebee' {
119
121
  limit?:number;
120
122
 
121
123
  /**
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.
124
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
123
125
 
124
126
  */
125
127
 
@@ -42,7 +42,7 @@ declare module 'chargebee' {
42
42
 
43
43
  shipping_addresses?:{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}[];
44
44
 
45
- discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
45
+ discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number,quantity?:number}[];
46
46
 
47
47
  subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,meta_data?:object,subscription_id?:string}[];
48
48
 
@@ -69,7 +69,7 @@ declare module 'chargebee' {
69
69
 
70
70
  shipping_addresses?:{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}[];
71
71
 
72
- discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
72
+ discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number,quantity?:number}[];
73
73
 
74
74
  subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,subscription_id?:string}[];
75
75
 
@@ -380,7 +380,7 @@ declare module 'chargebee' {
380
380
 
381
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}[];
382
382
 
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}[];
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,quantity?:number,start_date?:number}[];
384
384
 
385
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
386
 
@@ -425,7 +425,7 @@ declare module 'chargebee' {
425
425
 
426
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}[];
427
427
 
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}[];
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,quantity?:number,start_date?:number}[];
429
429
 
430
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
431
 
@@ -470,7 +470,7 @@ declare module 'chargebee' {
470
470
 
471
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}[];
472
472
 
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}[];
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,quantity?:number,start_date?:number}[];
474
474
 
475
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
476
 
@@ -529,7 +529,7 @@ declare module 'chargebee' {
529
529
 
530
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}[];
531
531
 
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}[];
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,quantity?:number,start_date?:number}[];
533
533
 
534
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
535
 
@@ -582,7 +582,7 @@ declare module 'chargebee' {
582
582
 
583
583
  charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
584
584
 
585
- discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
585
+ discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
586
586
 
587
587
  tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
588
588
 
@@ -619,7 +619,7 @@ declare module 'chargebee' {
619
619
 
620
620
  charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
621
621
 
622
- discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
622
+ discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
623
623
 
624
624
  tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
625
625
 
@@ -650,7 +650,7 @@ declare module 'chargebee' {
650
650
  limit?:number;
651
651
 
652
652
  /**
653
- * @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.
653
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
654
654
 
655
655
  */
656
656
 
@@ -723,7 +723,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
723
723
  limit?:number;
724
724
 
725
725
  /**
726
- * @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.
726
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
727
727
 
728
728
  */
729
729
 
@@ -14,6 +14,8 @@ declare module 'chargebee' {
14
14
 
15
15
  coupons?:QuotedCharge.Coupon[];
16
16
 
17
+ coupon_applicability_mappings?:QuotedCharge.CouponApplicabilityMapping[];
18
+
17
19
  }
18
20
  export namespace QuotedCharge {
19
21
 
@@ -85,5 +87,10 @@ declare module 'chargebee' {
85
87
  export interface Coupon {
86
88
  coupon_id:string;
87
89
  }
90
+ export interface CouponApplicabilityMapping {
91
+ coupon_id?:string;
92
+
93
+ applicable_item_price_ids?:string[];
94
+ }
88
95
  }
89
96
  }
@@ -83,15 +83,15 @@ declare module 'chargebee' {
83
83
  }
84
84
  export interface UpdateInputParam {
85
85
 
86
- items_to_add:{billing_cycles?:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
86
+ items_to_add:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
87
87
 
88
- items_to_update:{billing_cycles?:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
88
+ items_to_update:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
89
89
 
90
- 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}[];
90
+ item_tiers?:{ending_unit?:any,ending_unit_in_decimal?:any,item_price_id?:any,package_size?:any,price?:any,price_in_decimal?:any,pricing_type?:any,starting_unit?:any,starting_unit_in_decimal?:any}[];
91
91
 
92
- coupons_to_add?:{apply_till?:number,coupon_id?:string}[];
92
+ coupons_to_add?:{apply_till?:any,coupon_id?:any}[];
93
93
 
94
- discounts_to_add:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
94
+ discounts_to_add:{amount?:any,apply_on:any,duration_type:any,included_in_mrr?:any,item_price_id?:any,percentage?:any,period?:any,period_unit?:any}[];
95
95
 
96
96
  effective_from:number;
97
97
 
@@ -126,7 +126,7 @@ declare module 'chargebee' {
126
126
  limit?:number;
127
127
 
128
128
  /**
129
- * @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.
129
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
130
130
 
131
131
  */
132
132
 
@@ -22,6 +22,8 @@ declare module 'chargebee' {
22
22
 
23
23
  linked_omnichannel_subscriptions?:RecordedPurchase.LinkedOmnichannelSubscription[];
24
24
 
25
+ linked_omnichannel_one_time_orders?:RecordedPurchase.LinkedOmnichannelOneTimeOrder[];
26
+
25
27
  error_detail?:RecordedPurchase.ErrorDetail;
26
28
 
27
29
  }
@@ -42,7 +44,7 @@ declare module 'chargebee' {
42
44
 
43
45
  apple_app_store?:{product_id?:string,receipt?:string,transaction_id?:string};
44
46
 
45
- google_play_store?:{purchase_token?:string};
47
+ google_play_store?:{order_id?:string,product_id?:string,purchase_token?:string};
46
48
 
47
49
  omnichannel_subscription?:{id?:string};
48
50
 
@@ -55,6 +57,9 @@ declare module 'chargebee' {
55
57
  export interface LinkedOmnichannelSubscription {
56
58
  omnichannel_subscription_id?:string;
57
59
  }
60
+ export interface LinkedOmnichannelOneTimeOrder {
61
+ omnichannel_one_time_order_id?:string;
62
+ }
58
63
  export interface ErrorDetail {
59
64
  error_message?:string;
60
65
  }
@@ -36,7 +36,7 @@ declare module 'chargebee' {
36
36
  limit?:number;
37
37
 
38
38
  /**
39
- * @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.
39
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
40
40
 
41
41
  */
42
42
 
@@ -254,7 +254,7 @@ declare module 'chargebee' {
254
254
  }
255
255
  export interface CreateInputParam {
256
256
  [key : string] : any;
257
- customer?:object;
257
+ customer?:{allow_direct_debit?:boolean,auto_collection?:AutoCollection,business_customer_without_vat_number?:boolean,company?:string,consolidated_invoicing?:boolean,customer_type?:CustomerType,einvoicing_method?:EinvoicingMethod,email?:string,entity_code?:EntityCode,entity_identifier_scheme?:string,entity_identifier_standard?:string,exempt_number?:string,exemption_details?:any[],first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,net_term_days?:number,offline_payment_method?:OfflinePaymentMethod,phone?:string,registered_for_gst?:boolean,taxability?:Taxability,taxjar_exemption_category?:TaxjarExemptionCategory,vat_number?:string,vat_number_prefix?:string};
258
258
 
259
259
  card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
260
260
 
@@ -456,7 +456,7 @@ declare module 'chargebee' {
456
456
 
457
457
  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,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
458
458
 
459
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
459
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
460
460
 
461
461
  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}[];
462
462
 
@@ -535,7 +535,7 @@ declare module 'chargebee' {
535
535
  limit?:number;
536
536
 
537
537
  /**
538
- * @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.
538
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
539
539
 
540
540
  */
541
541
 
@@ -620,7 +620,7 @@ declare module 'chargebee' {
620
620
  created_at?:{after?:string,before?:string,between?:string,on?:string};
621
621
 
622
622
  /**
623
- * @description Time at which the subscription &#x60;status&#x60; last changed to &#x60;active&#x60;. For example, this value is updated when an &#x60;in_trial&#x60; or &#x60;cancelled&#x60; subscription activates.
623
+ * @description Time at which the subscription?&#x60;status&#x60;?last changed to? &#x60;active&#x60;. For example, this value is updated when an?&#x60;in_trial&#x60;?or? &#x60;cancelled&#x60;?subscription activates.
624
624
 
625
625
  */
626
626
 
@@ -710,7 +710,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
710
710
  limit?:number;
711
711
 
712
712
  /**
713
- * @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.
713
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
714
714
 
715
715
  */
716
716
 
@@ -731,7 +731,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
731
731
  limit?:number;
732
732
 
733
733
  /**
734
- * @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.
734
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
735
735
 
736
736
  */
737
737
 
@@ -754,7 +754,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
754
754
  limit?:number;
755
755
 
756
756
  /**
757
- * @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.
757
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
758
758
 
759
759
  */
760
760
 
@@ -956,7 +956,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
956
956
 
957
957
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
958
958
 
959
- 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}[];
959
+ 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,quantity?:number}[];
960
960
 
961
961
  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}[];
962
962
 
@@ -1209,7 +1209,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1209
1209
  }
1210
1210
  export interface ImportSubscriptionInputParam {
1211
1211
  [key : string] : any;
1212
- customer?:object;
1212
+ customer?:{allow_direct_debit?:boolean,auto_collection?:AutoCollection,company?:string,customer_type?:CustomerType,email?:string,entity_code?:EntityCode,exempt_number?:string,first_name?:string,id?:string,last_name?:string,locale?:string,net_term_days?:number,phone?:string,taxability?:Taxability,taxjar_exemption_category?:TaxjarExemptionCategory,vat_number?:string,vat_number_prefix?:string};
1213
1213
 
1214
1214
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
1215
1215
 
@@ -1380,7 +1380,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1380
1380
  }
1381
1381
  export interface ImportUnbilledChargesInputParam {
1382
1382
 
1383
- unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
1383
+ unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
1384
1384
 
1385
1385
  discounts:{amount:number,description?:string,entity_id?:string,entity_type?:'item_level_coupon' | 'document_level_coupon' | 'item_level_discount' | 'document_level_discount',unbilled_charge_id?:string}[];
1386
1386
 
@@ -1405,7 +1405,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1405
1405
 
1406
1406
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,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}[];
1407
1407
 
1408
- discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
1408
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
1409
1409
 
1410
1410
  charged_items?:{item_price_id?:string,last_charged_at?:number}[];
1411
1411
 
@@ -1861,12 +1861,14 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1861
1861
 
1862
1862
  invoice_name?:string;
1863
1863
 
1864
- type:'fixed_amount' | 'percentage';
1864
+ type:'fixed_amount' | 'percentage' | 'offer_quantity';
1865
1865
 
1866
1866
  percentage?:number;
1867
1867
 
1868
1868
  amount?:number;
1869
1869
 
1870
+ quantity?:number;
1871
+
1870
1872
  currency_code?:string;
1871
1873
 
1872
1874
  duration_type:'one_time' | 'forever' | 'limited_period';
@@ -52,7 +52,7 @@ declare module 'chargebee' {
52
52
  limit?:number;
53
53
 
54
54
  /**
55
- * @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.
55
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set &#x27;offset&#x27; to the value of &#x27;next_offset&#x27; obtained in the previous iteration of the API call.
56
56
 
57
57
  */
58
58
 
@@ -0,0 +1,12 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface SubscriptionEntitlementsCreatedDetail {
5
+
6
+
7
+ subscription_id?:string;
8
+
9
+ has_next:boolean;
10
+
11
+ }
12
+ }
@@ -0,0 +1,12 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface SubscriptionEntitlementsUpdatedDetail {
5
+
6
+
7
+ subscription_id?:string;
8
+
9
+ has_next:boolean;
10
+
11
+ }
12
+ }