chargebee 2.52.0 → 2.53.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.
- package/CHANGELOG.md +56 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +90 -5
- package/package.json +1 -1
- package/types/core.d.ts +2 -2
- package/types/index.d.ts +8 -0
- package/types/resources/Addon.d.ts +3 -3
- package/types/resources/AttachedItem.d.ts +1 -1
- package/types/resources/BusinessEntity.d.ts +2 -2
- package/types/resources/Comment.d.ts +5 -3
- package/types/resources/Coupon.d.ts +4 -4
- package/types/resources/CouponCode.d.ts +1 -1
- package/types/resources/CouponSet.d.ts +1 -1
- package/types/resources/CreditNote.d.ts +89 -89
- package/types/resources/Customer.d.ts +7 -7
- package/types/resources/CustomerEntitlement.d.ts +3 -1
- package/types/resources/DifferentialPrice.d.ts +1 -1
- package/types/resources/Discount.d.ts +3 -1
- package/types/resources/Entitlement.d.ts +1 -1
- package/types/resources/EntitlementOverride.d.ts +1 -1
- package/types/resources/Estimate.d.ts +4 -4
- package/types/resources/Event.d.ts +3 -3
- package/types/resources/Feature.d.ts +3 -3
- package/types/resources/Gift.d.ts +1 -1
- package/types/resources/HostedPage.d.ts +4 -4
- package/types/resources/ImpactedCustomer.d.ts +23 -0
- package/types/resources/Invoice.d.ts +110 -110
- package/types/resources/Item.d.ts +4 -4
- package/types/resources/ItemEntitlement.d.ts +2 -2
- package/types/resources/ItemFamily.d.ts +3 -3
- package/types/resources/ItemPrice.d.ts +7 -7
- package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
- package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
- package/types/resources/OmnichannelSubscription.d.ts +2 -2
- package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
- package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
- package/types/resources/Order.d.ts +3 -3
- package/types/resources/PaymentSource.d.ts +2 -2
- package/types/resources/PaymentVoucher.d.ts +4 -4
- package/types/resources/Plan.d.ts +3 -3
- package/types/resources/PriceVariant.d.ts +2 -2
- package/types/resources/PricingPageSession.d.ts +2 -2
- package/types/resources/PromotionalCredit.d.ts +3 -1
- package/types/resources/Purchase.d.ts +2 -2
- package/types/resources/Quote.d.ts +13 -13
- package/types/resources/QuotedCharge.d.ts +7 -0
- package/types/resources/Ramp.d.ts +7 -7
- package/types/resources/RecordedPurchase.d.ts +6 -1
- package/types/resources/SiteMigrationDetail.d.ts +1 -1
- package/types/resources/Subscription.d.ts +22 -20
- package/types/resources/SubscriptionEntitlement.d.ts +1 -1
- package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
- package/types/resources/Transaction.d.ts +6 -6
- package/types/resources/UnbilledCharge.d.ts +1 -1
- package/types/resources/Usage.d.ts +2 -2
- package/types/resources/UsageFile.d.ts +5 -5
- package/types/resources/VirtualBankAccount.d.ts +1 -1
- package/types/resources/WebhookEndpoint.d.ts +117 -0
|
@@ -46,8 +46,6 @@ declare module 'chargebee' {
|
|
|
46
46
|
|
|
47
47
|
channel?:Channel;
|
|
48
48
|
|
|
49
|
-
einvoice?:CreditNote.Einvoice;
|
|
50
|
-
|
|
51
49
|
sub_total:number;
|
|
52
50
|
|
|
53
51
|
sub_total_in_local_currency?:number;
|
|
@@ -62,15 +60,19 @@ declare module 'chargebee' {
|
|
|
62
60
|
|
|
63
61
|
line_items?:CreditNote.LineItem[];
|
|
64
62
|
|
|
65
|
-
|
|
63
|
+
line_item_tiers?:CreditNote.LineItemTier[];
|
|
66
64
|
|
|
67
65
|
line_item_discounts?:CreditNote.LineItemDiscount[];
|
|
68
66
|
|
|
69
|
-
|
|
67
|
+
line_item_taxes?:CreditNote.LineItemTax[];
|
|
68
|
+
|
|
69
|
+
line_item_addresses?:CreditNote.LineItemAddress[];
|
|
70
|
+
|
|
71
|
+
discounts?:CreditNote.Discount[];
|
|
70
72
|
|
|
71
73
|
taxes?:CreditNote.Tax[];
|
|
72
74
|
|
|
73
|
-
|
|
75
|
+
tax_origin?:CreditNote.TaxOrigin;
|
|
74
76
|
|
|
75
77
|
linked_refunds?:CreditNote.LinkedRefund[];
|
|
76
78
|
|
|
@@ -92,11 +94,9 @@ declare module 'chargebee' {
|
|
|
92
94
|
|
|
93
95
|
billing_address?:CreditNote.BillingAddress;
|
|
94
96
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
tax_origin?:CreditNote.TaxOrigin;
|
|
97
|
+
einvoice?:CreditNote.Einvoice;
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
site_details_at_creation?:CreditNote.SiteDetailsAtCreation;
|
|
100
100
|
|
|
101
101
|
}
|
|
102
102
|
export namespace CreditNote {
|
|
@@ -136,7 +136,7 @@ declare module 'chargebee' {
|
|
|
136
136
|
}
|
|
137
137
|
export interface CreateInputParam {
|
|
138
138
|
|
|
139
|
-
line_items?:{amount?:number,date_from?:number,date_to?:number,description?:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
139
|
+
line_items?:{amount?:number,date_from?:number,date_to?:number,description?:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan' | 'addon',quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
140
140
|
|
|
141
141
|
reference_invoice_id?:string;
|
|
142
142
|
|
|
@@ -196,7 +196,7 @@ declare module 'chargebee' {
|
|
|
196
196
|
}
|
|
197
197
|
export interface RecordRefundInputParam {
|
|
198
198
|
|
|
199
|
-
transaction:{amount?:number,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
|
|
199
|
+
transaction:{amount?:number,custom_payment_method_id?:string,date:number,id?:string,payment_method:PaymentMethod,reference_number?:string};
|
|
200
200
|
|
|
201
201
|
refund_reason_code?:string;
|
|
202
202
|
|
|
@@ -224,7 +224,7 @@ declare module 'chargebee' {
|
|
|
224
224
|
limit?:number;
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
227
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
228
228
|
|
|
229
229
|
*/
|
|
230
230
|
|
|
@@ -357,7 +357,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
357
357
|
|
|
358
358
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
359
359
|
|
|
360
|
-
sort_by?:
|
|
360
|
+
sort_by?:object;
|
|
361
361
|
|
|
362
362
|
/**
|
|
363
363
|
* @description The subscription channel this object originated from and is maintained in.
|
|
@@ -381,7 +381,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
381
381
|
limit?:number;
|
|
382
382
|
|
|
383
383
|
/**
|
|
384
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
384
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
385
385
|
|
|
386
386
|
*/
|
|
387
387
|
|
|
@@ -414,7 +414,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
414
414
|
}
|
|
415
415
|
export interface ImportCreditNoteInputParam {
|
|
416
416
|
|
|
417
|
-
line_items:{amount?:number,amount_in_decimal?:string,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
417
|
+
line_items:{amount?:number,amount_in_decimal?:string,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
418
418
|
|
|
419
419
|
line_item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,line_item_id:string,quantity_used?:number,quantity_used_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
420
420
|
|
|
@@ -424,7 +424,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
424
424
|
|
|
425
425
|
allocations:{allocated_amount:number,allocated_at:number,invoice_id:string}[];
|
|
426
426
|
|
|
427
|
-
linked_refunds:{amount:number,date:number,payment_method:PaymentMethod,reference_number?:string}[];
|
|
427
|
+
linked_refunds:{amount:number,date:number,id?:string,payment_method:PaymentMethod,reference_number?:string}[];
|
|
428
428
|
|
|
429
429
|
id:string;
|
|
430
430
|
|
|
@@ -458,15 +458,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
458
458
|
|
|
459
459
|
vat_number_prefix?:string;
|
|
460
460
|
}
|
|
461
|
-
export interface Einvoice {
|
|
462
|
-
id:string;
|
|
463
|
-
|
|
464
|
-
reference_number?:string;
|
|
465
|
-
|
|
466
|
-
status:'scheduled' | 'skipped' | 'in_progress' | 'success' | 'failed' | 'registered';
|
|
467
|
-
|
|
468
|
-
message?:string;
|
|
469
|
-
}
|
|
470
461
|
export interface LineItem {
|
|
471
462
|
id?:string;
|
|
472
463
|
|
|
@@ -518,30 +509,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
518
509
|
|
|
519
510
|
customer_id?:string;
|
|
520
511
|
}
|
|
521
|
-
export interface Discount {
|
|
522
|
-
amount:number;
|
|
523
|
-
|
|
524
|
-
description?:string;
|
|
525
|
-
|
|
526
|
-
entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
527
|
-
|
|
528
|
-
discount_type?:'fixed_amount' | 'percentage';
|
|
529
|
-
|
|
530
|
-
entity_id?:string;
|
|
531
|
-
|
|
532
|
-
coupon_set_code?:string;
|
|
533
|
-
}
|
|
534
|
-
export interface LineItemDiscount {
|
|
535
|
-
line_item_id:string;
|
|
536
|
-
|
|
537
|
-
discount_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
538
|
-
|
|
539
|
-
coupon_id?:string;
|
|
540
|
-
|
|
541
|
-
entity_id?:string;
|
|
542
|
-
|
|
543
|
-
discount_amount:number;
|
|
544
|
-
}
|
|
545
512
|
export interface LineItemTier {
|
|
546
513
|
line_item_id?:string;
|
|
547
514
|
|
|
@@ -565,12 +532,16 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
565
532
|
|
|
566
533
|
package_size?:number;
|
|
567
534
|
}
|
|
568
|
-
export interface
|
|
569
|
-
|
|
535
|
+
export interface LineItemDiscount {
|
|
536
|
+
line_item_id:string;
|
|
570
537
|
|
|
571
|
-
|
|
538
|
+
discount_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
572
539
|
|
|
573
|
-
|
|
540
|
+
coupon_id?:string;
|
|
541
|
+
|
|
542
|
+
entity_id?:string;
|
|
543
|
+
|
|
544
|
+
discount_amount:number;
|
|
574
545
|
}
|
|
575
546
|
export interface LineItemTax {
|
|
576
547
|
line_item_id?:string;
|
|
@@ -603,6 +574,62 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
603
574
|
|
|
604
575
|
local_currency_code?:string;
|
|
605
576
|
}
|
|
577
|
+
export interface LineItemAddress {
|
|
578
|
+
line_item_id?:string;
|
|
579
|
+
|
|
580
|
+
first_name?:string;
|
|
581
|
+
|
|
582
|
+
last_name?:string;
|
|
583
|
+
|
|
584
|
+
email?:string;
|
|
585
|
+
|
|
586
|
+
company?:string;
|
|
587
|
+
|
|
588
|
+
phone?:string;
|
|
589
|
+
|
|
590
|
+
line1?:string;
|
|
591
|
+
|
|
592
|
+
line2?:string;
|
|
593
|
+
|
|
594
|
+
line3?:string;
|
|
595
|
+
|
|
596
|
+
city?:string;
|
|
597
|
+
|
|
598
|
+
state_code?:string;
|
|
599
|
+
|
|
600
|
+
state?:string;
|
|
601
|
+
|
|
602
|
+
country?:string;
|
|
603
|
+
|
|
604
|
+
zip?:string;
|
|
605
|
+
|
|
606
|
+
validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
|
|
607
|
+
}
|
|
608
|
+
export interface Discount {
|
|
609
|
+
amount:number;
|
|
610
|
+
|
|
611
|
+
description?:string;
|
|
612
|
+
|
|
613
|
+
entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
614
|
+
|
|
615
|
+
discount_type?:'fixed_amount' | 'percentage';
|
|
616
|
+
|
|
617
|
+
entity_id?:string;
|
|
618
|
+
|
|
619
|
+
coupon_set_code?:string;
|
|
620
|
+
}
|
|
621
|
+
export interface Tax {
|
|
622
|
+
name:string;
|
|
623
|
+
|
|
624
|
+
amount:number;
|
|
625
|
+
|
|
626
|
+
description?:string;
|
|
627
|
+
}
|
|
628
|
+
export interface TaxOrigin {
|
|
629
|
+
country?:string;
|
|
630
|
+
|
|
631
|
+
registration_number?:string;
|
|
632
|
+
}
|
|
606
633
|
export interface LinkedRefund {
|
|
607
634
|
txn_id:string;
|
|
608
635
|
|
|
@@ -691,46 +718,19 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
691
718
|
|
|
692
719
|
validation_status?:ValidationStatus;
|
|
693
720
|
}
|
|
694
|
-
export interface
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
organization_address?:object;
|
|
698
|
-
}
|
|
699
|
-
export interface TaxOrigin {
|
|
700
|
-
country?:string;
|
|
701
|
-
|
|
702
|
-
registration_number?:string;
|
|
703
|
-
}
|
|
704
|
-
export interface LineItemAddress {
|
|
705
|
-
line_item_id?:string;
|
|
706
|
-
|
|
707
|
-
first_name?:string;
|
|
708
|
-
|
|
709
|
-
last_name?:string;
|
|
710
|
-
|
|
711
|
-
email?:string;
|
|
712
|
-
|
|
713
|
-
company?:string;
|
|
714
|
-
|
|
715
|
-
phone?:string;
|
|
716
|
-
|
|
717
|
-
line1?:string;
|
|
718
|
-
|
|
719
|
-
line2?:string;
|
|
720
|
-
|
|
721
|
-
line3?:string;
|
|
722
|
-
|
|
723
|
-
city?:string;
|
|
724
|
-
|
|
725
|
-
state_code?:string;
|
|
721
|
+
export interface Einvoice {
|
|
722
|
+
id:string;
|
|
726
723
|
|
|
727
|
-
|
|
724
|
+
reference_number?:string;
|
|
728
725
|
|
|
729
|
-
|
|
726
|
+
status:'scheduled' | 'skipped' | 'in_progress' | 'success' | 'failed' | 'registered';
|
|
730
727
|
|
|
731
|
-
|
|
728
|
+
message?:string;
|
|
729
|
+
}
|
|
730
|
+
export interface SiteDetailsAtCreation {
|
|
731
|
+
timezone?:string;
|
|
732
732
|
|
|
733
|
-
|
|
733
|
+
organization_address?:object;
|
|
734
734
|
}
|
|
735
735
|
}
|
|
736
736
|
}
|
|
@@ -197,7 +197,7 @@ declare module 'chargebee' {
|
|
|
197
197
|
card?:Card;
|
|
198
198
|
}
|
|
199
199
|
export interface CreateInputParam {
|
|
200
|
-
|
|
200
|
+
|
|
201
201
|
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};
|
|
202
202
|
|
|
203
203
|
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
@@ -295,7 +295,7 @@ declare module 'chargebee' {
|
|
|
295
295
|
limit?:number;
|
|
296
296
|
|
|
297
297
|
/**
|
|
298
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
298
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
299
299
|
|
|
300
300
|
*/
|
|
301
301
|
|
|
@@ -417,7 +417,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
417
417
|
|
|
418
418
|
business_entity_id?:{is?:string};
|
|
419
419
|
|
|
420
|
-
sort_by?:
|
|
420
|
+
sort_by?:object;
|
|
421
421
|
}
|
|
422
422
|
export interface RetrieveResponse {
|
|
423
423
|
customer:Customer;
|
|
@@ -431,7 +431,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
431
431
|
card?:Card;
|
|
432
432
|
}
|
|
433
433
|
export interface UpdateInputParam {
|
|
434
|
-
|
|
434
|
+
|
|
435
435
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
436
436
|
|
|
437
437
|
first_name?:string;
|
|
@@ -533,7 +533,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
533
533
|
limit?:number;
|
|
534
534
|
|
|
535
535
|
/**
|
|
536
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
536
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
537
537
|
|
|
538
538
|
*/
|
|
539
539
|
|
|
@@ -629,7 +629,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
629
629
|
}
|
|
630
630
|
export interface RecordExcessPaymentInputParam {
|
|
631
631
|
|
|
632
|
-
transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
|
|
632
|
+
transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,id?:string,payment_method:PaymentMethod,reference_number?:string};
|
|
633
633
|
|
|
634
634
|
comment?:string;
|
|
635
635
|
}
|
|
@@ -749,7 +749,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
749
749
|
limit?:number;
|
|
750
750
|
|
|
751
751
|
/**
|
|
752
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
752
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
753
753
|
|
|
754
754
|
*/
|
|
755
755
|
|
|
@@ -36,11 +36,13 @@ 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
|
|
39
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
40
40
|
|
|
41
41
|
*/
|
|
42
42
|
|
|
43
43
|
offset?:string;
|
|
44
|
+
|
|
45
|
+
consolidate_entitlements?:boolean;
|
|
44
46
|
}
|
|
45
47
|
|
|
46
48
|
}
|
|
@@ -108,7 +108,7 @@ declare module 'chargebee' {
|
|
|
108
108
|
limit?:number;
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
111
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
112
112
|
|
|
113
113
|
*/
|
|
114
114
|
|
|
@@ -8,12 +8,14 @@ declare module 'chargebee' {
|
|
|
8
8
|
|
|
9
9
|
invoice_name?:string;
|
|
10
10
|
|
|
11
|
-
type:'fixed_amount' | 'percentage';
|
|
11
|
+
type:'fixed_amount' | 'percentage' | 'offer_quantity';
|
|
12
12
|
|
|
13
13
|
percentage?:number;
|
|
14
14
|
|
|
15
15
|
amount?:number;
|
|
16
16
|
|
|
17
|
+
quantity?:number;
|
|
18
|
+
|
|
17
19
|
currency_code?:string;
|
|
18
20
|
|
|
19
21
|
duration_type:DurationType;
|
|
@@ -40,7 +40,7 @@ declare module 'chargebee' {
|
|
|
40
40
|
limit?:number;
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
43
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
44
44
|
|
|
45
45
|
*/
|
|
46
46
|
|
|
@@ -55,7 +55,7 @@ declare module 'chargebee' {
|
|
|
55
55
|
limit?:number;
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
58
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
59
59
|
|
|
60
60
|
*/
|
|
61
61
|
|
|
@@ -119,7 +119,7 @@ declare module 'chargebee' {
|
|
|
119
119
|
|
|
120
120
|
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}[];
|
|
121
121
|
|
|
122
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
122
|
+
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}[];
|
|
123
123
|
|
|
124
124
|
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}[];
|
|
125
125
|
|
|
@@ -189,7 +189,7 @@ declare module 'chargebee' {
|
|
|
189
189
|
|
|
190
190
|
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}[];
|
|
191
191
|
|
|
192
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
192
|
+
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}[];
|
|
193
193
|
|
|
194
194
|
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}[];
|
|
195
195
|
|
|
@@ -279,7 +279,7 @@ declare module 'chargebee' {
|
|
|
279
279
|
|
|
280
280
|
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}[];
|
|
281
281
|
|
|
282
|
-
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}[];
|
|
282
|
+
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}[];
|
|
283
283
|
|
|
284
284
|
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}[];
|
|
285
285
|
|
|
@@ -547,7 +547,7 @@ declare module 'chargebee' {
|
|
|
547
547
|
|
|
548
548
|
notes_to_remove?:{entity_id?:string,entity_type?:EntityType}[];
|
|
549
549
|
|
|
550
|
-
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
550
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
|
|
551
551
|
|
|
552
552
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
553
553
|
|
|
@@ -46,7 +46,7 @@ declare module 'chargebee' {
|
|
|
46
46
|
limit?:number;
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
49
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
50
50
|
|
|
51
51
|
*/
|
|
52
52
|
|
|
@@ -76,7 +76,7 @@ declare module 'chargebee' {
|
|
|
76
76
|
|
|
77
77
|
*/
|
|
78
78
|
|
|
79
|
-
event_type?:{in?:string,is?:'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed',is_not?:'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed',not_in?:string};
|
|
79
|
+
event_type?:{in?:string,is?:'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled',is_not?:'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled',not_in?:string};
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
82
|
* @description Source of the event
|
|
@@ -92,7 +92,7 @@ declare module 'chargebee' {
|
|
|
92
92
|
|
|
93
93
|
occurred_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
94
94
|
|
|
95
|
-
sort_by?:
|
|
95
|
+
sort_by?:object;
|
|
96
96
|
}
|
|
97
97
|
export interface RetrieveResponse {
|
|
98
98
|
event:Event;
|
|
@@ -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
|
|
61
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
62
62
|
|
|
63
63
|
*/
|
|
64
64
|
|
|
@@ -97,7 +97,7 @@ declare module 'chargebee' {
|
|
|
97
97
|
feature:Feature;
|
|
98
98
|
}
|
|
99
99
|
export interface CreateInputParam {
|
|
100
|
-
|
|
100
|
+
|
|
101
101
|
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
102
102
|
|
|
103
103
|
id?:string;
|
|
@@ -114,7 +114,7 @@ declare module 'chargebee' {
|
|
|
114
114
|
feature:Feature;
|
|
115
115
|
}
|
|
116
116
|
export interface UpdateInputParam {
|
|
117
|
-
|
|
117
|
+
|
|
118
118
|
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
119
119
|
|
|
120
120
|
name?:string;
|
|
@@ -124,7 +124,7 @@ declare module 'chargebee' {
|
|
|
124
124
|
limit?:number;
|
|
125
125
|
|
|
126
126
|
/**
|
|
127
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
127
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
128
128
|
|
|
129
129
|
*/
|
|
130
130
|
|
|
@@ -178,7 +178,7 @@ declare module 'chargebee' {
|
|
|
178
178
|
|
|
179
179
|
charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,date_from?:number,date_to?:number,description?:string,hsn_code?:string,tax_profile_id?:string,taxable?:boolean,taxjar_product_code?:string}[];
|
|
180
180
|
|
|
181
|
-
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
181
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
|
|
182
182
|
|
|
183
183
|
entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
|
|
184
184
|
|
|
@@ -219,7 +219,7 @@ declare module 'chargebee' {
|
|
|
219
219
|
|
|
220
220
|
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}[];
|
|
221
221
|
|
|
222
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
222
|
+
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}[];
|
|
223
223
|
|
|
224
224
|
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}[];
|
|
225
225
|
|
|
@@ -313,7 +313,7 @@ declare module 'chargebee' {
|
|
|
313
313
|
|
|
314
314
|
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}[];
|
|
315
315
|
|
|
316
|
-
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}[];
|
|
316
|
+
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}[];
|
|
317
317
|
|
|
318
318
|
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}[];
|
|
319
319
|
|
|
@@ -510,7 +510,7 @@ declare module 'chargebee' {
|
|
|
510
510
|
limit?:number;
|
|
511
511
|
|
|
512
512
|
/**
|
|
513
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
513
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
514
514
|
|
|
515
515
|
*/
|
|
516
516
|
|