chargebee 3.8.0-beta.1 → 3.8.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.
@@ -73,6 +73,7 @@ declare module 'chargebee' {
73
73
 
74
74
  retrieve(
75
75
  credit_note_id: string,
76
+ input?: RetrieveInputParam,
76
77
  headers?: ChargebeeRequestHeader,
77
78
  ): Promise<ChargebeeResponse<RetrieveResponse>>;
78
79
 
@@ -240,7 +241,7 @@ declare module 'chargebee' {
240
241
  discount_amount?: number;
241
242
  item_level_discount_amount?: number;
242
243
  metered?: boolean;
243
- percentage?: string;
244
+ is_percentage_pricing?: boolean;
244
245
  reference_line_item_id?: string;
245
246
  description: string;
246
247
  entity_description?: string;
@@ -450,6 +451,9 @@ declare module 'chargebee' {
450
451
  comment?: string;
451
452
  line_items?: LineItemsCreateInputParam[];
452
453
  }
454
+ export interface RetrieveInputParam {
455
+ line_item?: LineItemRetrieveInputParam;
456
+ }
453
457
  export interface PdfInputParam {
454
458
  disposition_type?: DispositionTypeEnum;
455
459
  }
@@ -542,6 +546,11 @@ declare module 'chargebee' {
542
546
  | 'charge_item_price';
543
547
  entity_id?: string;
544
548
  }
549
+ export interface LineItemRetrieveInputParam {
550
+ subscription_id?: filter.String;
551
+ customer_id?: filter.String;
552
+ }
553
+
545
554
  export interface TransactionRecordRefundInputParam {
546
555
  amount?: number;
547
556
  payment_method: PaymentMethodEnum;
@@ -45,7 +45,7 @@ declare module 'chargebee' {
45
45
  discount_amount?: number;
46
46
  item_level_discount_amount?: number;
47
47
  metered?: boolean;
48
- percentage?: string;
48
+ is_percentage_pricing?: boolean;
49
49
  reference_line_item_id?: string;
50
50
  description: string;
51
51
  entity_description?: string;
@@ -275,6 +275,7 @@ declare module 'chargebee' {
275
275
  shipping_address?: ShippingAddressCreateSubItemForCustomerEstimateInputParam;
276
276
  billing_address?: BillingAddressCreateSubItemForCustomerEstimateInputParam;
277
277
  contract_term?: ContractTermCreateSubItemForCustomerEstimateInputParam;
278
+ billing_override?: BillingOverrideCreateSubItemForCustomerEstimateInputParam;
278
279
  subscription_items?: SubscriptionItemsCreateSubItemForCustomerEstimateInputParam[];
279
280
  discounts?: DiscountsCreateSubItemForCustomerEstimateInputParam[];
280
281
  item_tiers?: ItemTiersCreateSubItemForCustomerEstimateInputParam[];
@@ -329,6 +330,7 @@ declare module 'chargebee' {
329
330
  billing_address?: BillingAddressUpdateSubscriptionForItemsInputParam;
330
331
  shipping_address?: ShippingAddressUpdateSubscriptionForItemsInputParam;
331
332
  customer?: CustomerUpdateSubscriptionForItemsInputParam;
333
+ billing_override?: BillingOverrideUpdateSubscriptionForItemsInputParam;
332
334
  subscription_items?: SubscriptionItemsUpdateSubscriptionForItemsInputParam[];
333
335
  discounts?: DiscountsUpdateSubscriptionForItemsInputParam[];
334
336
  item_tiers?: ItemTiersUpdateSubscriptionForItemsInputParam[];
@@ -691,6 +693,10 @@ declare module 'chargebee' {
691
693
  billing_cycles?: number;
692
694
  trial_end?: number;
693
695
  }
696
+ export interface BillingOverrideCreateSubItemForCustomerEstimateInputParam {
697
+ max_excess_payment_usage?: number;
698
+ max_refundable_credits_usage?: number;
699
+ }
694
700
  export interface BillingAddressCreateSubItemForCustomerEstimateInputParam {
695
701
  line1?: string;
696
702
  line2?: string;
@@ -842,6 +848,10 @@ declare module 'chargebee' {
842
848
  trial_end?: number;
843
849
  proration_type?: ProrationTypeEnum;
844
850
  }
851
+ export interface BillingOverrideUpdateSubscriptionForItemsInputParam {
852
+ max_excess_payment_usage?: number;
853
+ max_refundable_credits_usage?: number;
854
+ }
845
855
  export interface BillingAddressUpdateSubscriptionForItemsInputParam {
846
856
  line1?: string;
847
857
  line2?: string;
@@ -112,6 +112,18 @@ declare module 'chargebee' {
112
112
  headers?: ChargebeeRequestHeader,
113
113
  ): Promise<ChargebeeResponse<StopDunningResponse>>;
114
114
 
115
+ pauseDunning(
116
+ invoice_id: string,
117
+ input: PauseDunningInputParam,
118
+ headers?: ChargebeeRequestHeader,
119
+ ): Promise<ChargebeeResponse<PauseDunningResponse>>;
120
+
121
+ resumeDunning(
122
+ invoice_id: string,
123
+ input?: ResumeDunningInputParam,
124
+ headers?: ChargebeeRequestHeader,
125
+ ): Promise<ChargebeeResponse<ResumeDunningResponse>>;
126
+
115
127
  importInvoice(
116
128
  input: ImportInvoiceInputParam,
117
129
  headers?: ChargebeeRequestHeader,
@@ -159,6 +171,7 @@ declare module 'chargebee' {
159
171
 
160
172
  retrieve(
161
173
  invoice_id: string,
174
+ input?: RetrieveInputParam,
162
175
  headers?: ChargebeeRequestHeader,
163
176
  ): Promise<ChargebeeResponse<RetrieveResponse>>;
164
177
 
@@ -320,6 +333,14 @@ declare module 'chargebee' {
320
333
  invoice: Invoice;
321
334
  }
322
335
 
336
+ export interface PauseDunningResponse {
337
+ invoice: Invoice;
338
+ }
339
+
340
+ export interface ResumeDunningResponse {
341
+ invoice: Invoice;
342
+ }
343
+
323
344
  export interface ImportInvoiceResponse {
324
345
  invoice: Invoice;
325
346
  credit_note?: CreditNote;
@@ -486,7 +507,7 @@ declare module 'chargebee' {
486
507
  discount_amount?: number;
487
508
  item_level_discount_amount?: number;
488
509
  metered?: boolean;
489
- percentage?: string;
510
+ is_percentage_pricing?: boolean;
490
511
  reference_line_item_id?: string;
491
512
  description: string;
492
513
  entity_description?: string;
@@ -702,7 +723,9 @@ declare module 'chargebee' {
702
723
  created_at: number;
703
724
  }
704
725
  export interface Note {
705
- entity_type:
726
+ note: string;
727
+ entity_id?: string;
728
+ entity_type?:
706
729
  | 'coupon'
707
730
  | 'subscription'
708
731
  | 'customer'
@@ -712,8 +735,6 @@ declare module 'chargebee' {
712
735
  | 'tax'
713
736
  | 'plan'
714
737
  | 'addon';
715
- note: string;
716
- entity_id?: string;
717
738
  }
718
739
  export interface ShippingAddress {
719
740
  first_name?: string;
@@ -917,6 +938,13 @@ declare module 'chargebee' {
917
938
  export interface StopDunningInputParam {
918
939
  comment?: string;
919
940
  }
941
+ export interface PauseDunningInputParam {
942
+ expected_payment_date: number;
943
+ comment?: string;
944
+ }
945
+ export interface ResumeDunningInputParam {
946
+ comment?: string;
947
+ }
920
948
  export interface ImportInvoiceInputParam {
921
949
  id: string;
922
950
  currency_code?: string;
@@ -1008,6 +1036,9 @@ declare module 'chargebee' {
1008
1036
  limit?: number;
1009
1037
  offset?: string;
1010
1038
  }
1039
+ export interface RetrieveInputParam {
1040
+ line_item?: LineItemRetrieveInputParam;
1041
+ }
1011
1042
  export interface PdfInputParam {
1012
1043
  disposition_type?: DispositionTypeEnum;
1013
1044
  }
@@ -1615,6 +1646,11 @@ declare module 'chargebee' {
1615
1646
  status?: filter.Enum;
1616
1647
  }
1617
1648
 
1649
+ export interface LineItemRetrieveInputParam {
1650
+ subscription_id?: filter.String;
1651
+ customer_id?: filter.String;
1652
+ }
1653
+
1618
1654
  export interface PaymentReferenceNumberInvoiceListPaymentReferenceNumbersInputParam {
1619
1655
  number?: filter.String;
1620
1656
  }
@@ -47,7 +47,7 @@ declare module 'chargebee' {
47
47
  discount_amount?: number;
48
48
  item_level_discount_amount?: number;
49
49
  metered?: boolean;
50
- percentage?: string;
50
+ is_percentage_pricing?: boolean;
51
51
  reference_line_item_id?: string;
52
52
  description: string;
53
53
  entity_description?: string;
@@ -119,9 +119,9 @@ declare module 'chargebee' {
119
119
  included_in_mrr?: boolean;
120
120
  metered?: boolean;
121
121
  usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
122
+ is_percentage_pricing?: boolean;
122
123
  metadata?: any;
123
124
  business_entity_id?: string;
124
- is_percentage_pricing?: boolean;
125
125
  bundle_configuration?: BundleConfigurationCreateInputParam;
126
126
  bundle_items_to_add?: BundleItemsToAddCreateInputParam[];
127
127
  [key: `cf_${string}`]: unknown;
@@ -146,6 +146,7 @@ declare module 'chargebee' {
146
146
  metadata?: any;
147
147
  included_in_mrr?: boolean;
148
148
  status?: 'active' | 'archived';
149
+ is_percentage_pricing?: boolean;
149
150
  bundle_configuration?: BundleConfigurationUpdateInputParam;
150
151
  bundle_items_to_add?: BundleItemsToAddUpdateInputParam[];
151
152
  bundle_items_to_update?: BundleItemsToUpdateUpdateInputParam[];
@@ -26,9 +26,11 @@ declare module 'chargebee' {
26
26
  | 'refunded_for_other_reason'
27
27
  | 'merchant_revoked';
28
28
  grace_period_expires_at?: number;
29
+ resumes_at?: number;
29
30
  has_scheduled_changes: boolean;
30
31
  resource_version?: number;
31
32
  upcoming_renewal?: OmnichannelSubscriptionItem.UpcomingRenewal;
33
+ linked_item?: OmnichannelSubscriptionItem.LinkedItem;
32
34
  }
33
35
 
34
36
  export namespace OmnichannelSubscriptionItem {
@@ -52,6 +54,10 @@ declare module 'chargebee' {
52
54
  price_units?: number;
53
55
  price_nanos?: number;
54
56
  }
57
+ export interface LinkedItem {
58
+ id: string;
59
+ linked_at?: number;
60
+ }
55
61
  // REQUEST PARAMS
56
62
  //---------------
57
63
 
@@ -10,11 +10,22 @@ declare module 'chargebee' {
10
10
  customer_id: string;
11
11
  subscription_id?: string;
12
12
  invoice_id?: string;
13
- status: 'open' | 'accepted' | 'declined' | 'invoiced' | 'closed';
13
+ status:
14
+ | 'open'
15
+ | 'accepted'
16
+ | 'declined'
17
+ | 'invoiced'
18
+ | 'closed'
19
+ | 'pending_approval'
20
+ | 'approval_rejected'
21
+ | 'proposed'
22
+ | 'voided'
23
+ | 'expired';
14
24
  operation_type:
15
25
  | 'create_subscription_for_customer'
16
26
  | 'change_subscription'
17
- | 'onetime_invoice';
27
+ | 'onetime_invoice'
28
+ | 'renew_subscription';
18
29
  vat_number?: string;
19
30
  price_type: PriceTypeEnum;
20
31
  valid_till: number;
@@ -46,6 +57,8 @@ declare module 'chargebee' {
46
57
  contract_term_termination_fee?: number;
47
58
  business_entity_id?: string;
48
59
  deleted: boolean;
60
+ total_contract_value?: number;
61
+ total_discount?: number;
49
62
  }
50
63
 
51
64
  export namespace Quote {
@@ -299,7 +312,7 @@ declare module 'chargebee' {
299
312
  discount_amount?: number;
300
313
  item_level_discount_amount?: number;
301
314
  metered?: boolean;
302
- percentage?: string;
315
+ is_percentage_pricing?: boolean;
303
316
  reference_line_item_id?: string;
304
317
  description: string;
305
318
  entity_description?: string;
@@ -542,12 +555,16 @@ declare module 'chargebee' {
542
555
  terms_to_charge?: number;
543
556
  billing_alignment_mode?: BillingAlignmentModeEnum;
544
557
  coupon_ids?: string[];
558
+ billing_start_option?: BillingStartOptionEnum;
559
+ net_term_days?: number;
545
560
  subscription?: SubscriptionCreateSubItemsForCustomerQuoteInputParam;
546
561
  shipping_address?: ShippingAddressCreateSubItemsForCustomerQuoteInputParam;
547
562
  contract_term?: ContractTermCreateSubItemsForCustomerQuoteInputParam;
563
+ billing_address?: BillingAddressCreateSubItemsForCustomerQuoteInputParam;
548
564
  subscription_items?: SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam[];
549
565
  discounts?: DiscountsCreateSubItemsForCustomerQuoteInputParam[];
550
566
  item_tiers?: ItemTiersCreateSubItemsForCustomerQuoteInputParam[];
567
+ coupons?: CouponsCreateSubItemsForCustomerQuoteInputParam[];
551
568
  [key: `cf_${string}`]: unknown;
552
569
  }
553
570
  export interface EditCreateSubCustomerQuoteForItemsInputParam {
@@ -558,12 +575,16 @@ declare module 'chargebee' {
558
575
  terms_to_charge?: number;
559
576
  billing_alignment_mode?: BillingAlignmentModeEnum;
560
577
  coupon_ids?: string[];
578
+ billing_start_option?: BillingStartOptionEnum;
579
+ net_term_days?: number;
561
580
  subscription?: SubscriptionEditCreateSubCustomerQuoteForItemsInputParam;
562
581
  shipping_address?: ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam;
563
582
  contract_term?: ContractTermEditCreateSubCustomerQuoteForItemsInputParam;
583
+ billing_address?: BillingAddressEditCreateSubCustomerQuoteForItemsInputParam;
564
584
  subscription_items?: SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam[];
565
585
  discounts?: DiscountsEditCreateSubCustomerQuoteForItemsInputParam[];
566
586
  item_tiers?: ItemTiersEditCreateSubCustomerQuoteForItemsInputParam[];
587
+ coupons?: CouponsEditCreateSubCustomerQuoteForItemsInputParam[];
567
588
  [key: `cf_${string}`]: unknown;
568
589
  }
569
590
  export interface UpdateSubscriptionQuoteForItemsInputParam {
@@ -582,6 +603,7 @@ declare module 'chargebee' {
582
603
  changes_scheduled_at?: number;
583
604
  force_term_reset?: boolean;
584
605
  reactivate?: boolean;
606
+ net_term_days?: number;
585
607
  subscription?: SubscriptionUpdateSubscriptionQuoteForItemsInputParam;
586
608
  billing_address?: BillingAddressUpdateSubscriptionQuoteForItemsInputParam;
587
609
  shipping_address?: ShippingAddressUpdateSubscriptionQuoteForItemsInputParam;
@@ -590,6 +612,7 @@ declare module 'chargebee' {
590
612
  subscription_items?: SubscriptionItemsUpdateSubscriptionQuoteForItemsInputParam[];
591
613
  discounts?: DiscountsUpdateSubscriptionQuoteForItemsInputParam[];
592
614
  item_tiers?: ItemTiersUpdateSubscriptionQuoteForItemsInputParam[];
615
+ coupons?: CouponsUpdateSubscriptionQuoteForItemsInputParam[];
593
616
  [key: `cf_${string}`]: unknown;
594
617
  }
595
618
  export interface EditUpdateSubscriptionQuoteForItemsInputParam {
@@ -607,6 +630,7 @@ declare module 'chargebee' {
607
630
  changes_scheduled_at?: number;
608
631
  force_term_reset?: boolean;
609
632
  reactivate?: boolean;
633
+ net_term_days?: number;
610
634
  subscription?: SubscriptionEditUpdateSubscriptionQuoteForItemsInputParam;
611
635
  billing_address?: BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam;
612
636
  shipping_address?: ShippingAddressEditUpdateSubscriptionQuoteForItemsInputParam;
@@ -615,6 +639,7 @@ declare module 'chargebee' {
615
639
  subscription_items?: SubscriptionItemsEditUpdateSubscriptionQuoteForItemsInputParam[];
616
640
  discounts?: DiscountsEditUpdateSubscriptionQuoteForItemsInputParam[];
617
641
  item_tiers?: ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam[];
642
+ coupons?: CouponsEditUpdateSubscriptionQuoteForItemsInputParam[];
618
643
  [key: `cf_${string}`]: unknown;
619
644
  }
620
645
  export interface CreateForChargeItemsAndChargesInputParam {
@@ -626,6 +651,7 @@ declare module 'chargebee' {
626
651
  currency_code?: string;
627
652
  coupon?: string;
628
653
  coupon_ids?: string[];
654
+ billing_address?: BillingAddressCreateForChargeItemsAndChargesInputParam;
629
655
  shipping_address?: ShippingAddressCreateForChargeItemsAndChargesInputParam;
630
656
  item_prices?: ItemPricesCreateForChargeItemsAndChargesInputParam[];
631
657
  item_tiers?: ItemTiersCreateForChargeItemsAndChargesInputParam[];
@@ -640,6 +666,7 @@ declare module 'chargebee' {
640
666
  currency_code?: string;
641
667
  coupon?: string;
642
668
  coupon_ids?: string[];
669
+ billing_address?: BillingAddressEditForChargeItemsAndChargesInputParam;
643
670
  shipping_address?: ShippingAddressEditForChargeItemsAndChargesInputParam;
644
671
  item_prices?: ItemPricesEditForChargeItemsAndChargesInputParam[];
645
672
  item_tiers?: ItemTiersEditForChargeItemsAndChargesInputParam[];
@@ -673,7 +700,7 @@ declare module 'chargebee' {
673
700
  subscription?: SubscriptionConvertInputParam;
674
701
  }
675
702
  export interface UpdateStatusInputParam {
676
- status: 'accepted' | 'declined' | 'closed';
703
+ status: 'accepted' | 'declined' | 'proposed' | 'voided' | 'closed';
677
704
  comment?: string;
678
705
  }
679
706
  export interface ExtendExpiryDateInputParam {
@@ -1033,6 +1060,22 @@ declare module 'chargebee' {
1033
1060
  field_id?: string;
1034
1061
  field_value?: string;
1035
1062
  }
1063
+ export interface BillingAddressCreateSubItemsForCustomerQuoteInputParam {
1064
+ first_name?: string;
1065
+ last_name?: string;
1066
+ email?: string;
1067
+ company?: string;
1068
+ phone?: string;
1069
+ line1?: string;
1070
+ line2?: string;
1071
+ line3?: string;
1072
+ city?: string;
1073
+ state_code?: string;
1074
+ state?: string;
1075
+ zip?: string;
1076
+ country?: string;
1077
+ validation_status?: ValidationStatusEnum;
1078
+ }
1036
1079
  export interface ShippingAddressCreateSubItemsForCustomerQuoteInputParam {
1037
1080
  first_name?: string;
1038
1081
  last_name?: string;
@@ -1081,6 +1124,9 @@ declare module 'chargebee' {
1081
1124
  */
1082
1125
  item_type?: ItemTypeEnum;
1083
1126
  charge_on_option?: ChargeOnOptionEnum;
1127
+ start_date?: number;
1128
+ end_date?: number;
1129
+ ramp_tier_id?: string;
1084
1130
  }
1085
1131
  export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
1086
1132
  apply_on?: ApplyOnEnum;
@@ -1091,6 +1137,13 @@ declare module 'chargebee' {
1091
1137
  period_unit?: PeriodUnitEnum;
1092
1138
  included_in_mrr?: boolean;
1093
1139
  item_price_id?: string;
1140
+ start_date?: number;
1141
+ end_date?: number;
1142
+ }
1143
+ export interface CouponsCreateSubItemsForCustomerQuoteInputParam {
1144
+ id?: string;
1145
+ start_date?: number;
1146
+ end_date?: number;
1094
1147
  }
1095
1148
  export interface ItemTiersCreateSubItemsForCustomerQuoteInputParam {
1096
1149
  item_price_id?: string;
@@ -1102,6 +1155,23 @@ declare module 'chargebee' {
1102
1155
  price_in_decimal?: string;
1103
1156
  pricing_type?: PricingTypeEnum;
1104
1157
  package_size?: number;
1158
+ ramp_tier_id?: string;
1159
+ }
1160
+ export interface BillingAddressEditCreateSubCustomerQuoteForItemsInputParam {
1161
+ first_name?: string;
1162
+ last_name?: string;
1163
+ email?: string;
1164
+ company?: string;
1165
+ phone?: string;
1166
+ line1?: string;
1167
+ line2?: string;
1168
+ line3?: string;
1169
+ city?: string;
1170
+ state_code?: string;
1171
+ state?: string;
1172
+ zip?: string;
1173
+ country?: string;
1174
+ validation_status?: ValidationStatusEnum;
1105
1175
  }
1106
1176
  export interface ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam {
1107
1177
  first_name?: string;
@@ -1151,6 +1221,9 @@ declare module 'chargebee' {
1151
1221
  */
1152
1222
  item_type?: ItemTypeEnum;
1153
1223
  charge_on_option?: ChargeOnOptionEnum;
1224
+ start_date?: number;
1225
+ end_date?: number;
1226
+ ramp_tier_id?: string;
1154
1227
  }
1155
1228
  export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
1156
1229
  apply_on?: ApplyOnEnum;
@@ -1161,6 +1234,13 @@ declare module 'chargebee' {
1161
1234
  period_unit?: PeriodUnitEnum;
1162
1235
  included_in_mrr?: boolean;
1163
1236
  item_price_id?: string;
1237
+ start_date?: number;
1238
+ end_date?: number;
1239
+ }
1240
+ export interface CouponsEditCreateSubCustomerQuoteForItemsInputParam {
1241
+ id?: string;
1242
+ start_date?: number;
1243
+ end_date?: number;
1164
1244
  }
1165
1245
  export interface ItemTiersEditCreateSubCustomerQuoteForItemsInputParam {
1166
1246
  item_price_id?: string;
@@ -1172,6 +1252,7 @@ declare module 'chargebee' {
1172
1252
  price_in_decimal?: string;
1173
1253
  pricing_type?: PricingTypeEnum;
1174
1254
  package_size?: number;
1255
+ ramp_tier_id?: string;
1175
1256
  }
1176
1257
  export interface BillingAddressUpdateSubscriptionQuoteForItemsInputParam {
1177
1258
  first_name?: string;
@@ -1247,6 +1328,9 @@ declare module 'chargebee' {
1247
1328
  * @deprecated Please refer API docs to use other attributes
1248
1329
  */
1249
1330
  item_type?: ItemTypeEnum;
1331
+ start_date?: number;
1332
+ end_date?: number;
1333
+ ramp_tier_id?: string;
1250
1334
  }
1251
1335
  export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
1252
1336
  apply_on?: ApplyOnEnum;
@@ -1259,6 +1343,13 @@ declare module 'chargebee' {
1259
1343
  item_price_id?: string;
1260
1344
  operation_type: OperationTypeEnum;
1261
1345
  id?: string;
1346
+ start_date?: number;
1347
+ end_date?: number;
1348
+ }
1349
+ export interface CouponsUpdateSubscriptionQuoteForItemsInputParam {
1350
+ id?: string;
1351
+ start_date?: number;
1352
+ end_date?: number;
1262
1353
  }
1263
1354
  export interface ItemTiersUpdateSubscriptionQuoteForItemsInputParam {
1264
1355
  item_price_id?: string;
@@ -1270,6 +1361,7 @@ declare module 'chargebee' {
1270
1361
  price_in_decimal?: string;
1271
1362
  pricing_type?: PricingTypeEnum;
1272
1363
  package_size?: number;
1364
+ ramp_tier_id?: string;
1273
1365
  }
1274
1366
  export interface BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
1275
1367
  first_name?: string;
@@ -1344,6 +1436,9 @@ declare module 'chargebee' {
1344
1436
  * @deprecated Please refer API docs to use other attributes
1345
1437
  */
1346
1438
  item_type?: ItemTypeEnum;
1439
+ start_date?: number;
1440
+ end_date?: number;
1441
+ ramp_tier_id?: string;
1347
1442
  }
1348
1443
  export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
1349
1444
  apply_on?: ApplyOnEnum;
@@ -1356,6 +1451,13 @@ declare module 'chargebee' {
1356
1451
  item_price_id?: string;
1357
1452
  operation_type: OperationTypeEnum;
1358
1453
  id?: string;
1454
+ start_date?: number;
1455
+ end_date?: number;
1456
+ }
1457
+ export interface CouponsEditUpdateSubscriptionQuoteForItemsInputParam {
1458
+ id?: string;
1459
+ start_date?: number;
1460
+ end_date?: number;
1359
1461
  }
1360
1462
  export interface ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam {
1361
1463
  item_price_id?: string;
@@ -1367,6 +1469,23 @@ declare module 'chargebee' {
1367
1469
  price_in_decimal?: string;
1368
1470
  pricing_type?: PricingTypeEnum;
1369
1471
  package_size?: number;
1472
+ ramp_tier_id?: string;
1473
+ }
1474
+ export interface BillingAddressCreateForChargeItemsAndChargesInputParam {
1475
+ first_name?: string;
1476
+ last_name?: string;
1477
+ email?: string;
1478
+ company?: string;
1479
+ phone?: string;
1480
+ line1?: string;
1481
+ line2?: string;
1482
+ line3?: string;
1483
+ city?: string;
1484
+ state_code?: string;
1485
+ state?: string;
1486
+ zip?: string;
1487
+ country?: string;
1488
+ validation_status?: ValidationStatusEnum;
1370
1489
  }
1371
1490
  export interface ShippingAddressCreateForChargeItemsAndChargesInputParam {
1372
1491
  first_name?: string;
@@ -1424,6 +1543,22 @@ declare module 'chargebee' {
1424
1543
  field_id?: string;
1425
1544
  field_value?: string;
1426
1545
  }
1546
+ export interface BillingAddressEditForChargeItemsAndChargesInputParam {
1547
+ first_name?: string;
1548
+ last_name?: string;
1549
+ email?: string;
1550
+ company?: string;
1551
+ phone?: string;
1552
+ line1?: string;
1553
+ line2?: string;
1554
+ line3?: string;
1555
+ city?: string;
1556
+ state_code?: string;
1557
+ state?: string;
1558
+ zip?: string;
1559
+ country?: string;
1560
+ validation_status?: ValidationStatusEnum;
1561
+ }
1427
1562
  export interface ShippingAddressEditForChargeItemsAndChargesInputParam {
1428
1563
  first_name?: string;
1429
1564
  last_name?: string;
@@ -49,7 +49,7 @@ declare module 'chargebee' {
49
49
  discount_amount?: number;
50
50
  item_level_discount_amount?: number;
51
51
  metered?: boolean;
52
- percentage?: string;
52
+ is_percentage_pricing?: boolean;
53
53
  reference_line_item_id?: string;
54
54
  description: string;
55
55
  entity_description?: string;
@@ -0,0 +1,93 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface QuotedRamp {
6
+ id: string;
7
+ line_items?: QuotedRamp.LineItem[];
8
+ discounts?: QuotedRamp.Discount[];
9
+ item_tiers?: QuotedRamp.ItemTier[];
10
+ }
11
+
12
+ export namespace QuotedRamp {
13
+ export interface LineItem {
14
+ item_price_id: string;
15
+ item_type: 'plan' | 'addon' | 'charge';
16
+ quantity?: number;
17
+ quantity_in_decimal?: string;
18
+ metered_quantity?: string;
19
+ unit_price?: number;
20
+ unit_price_in_decimal?: string;
21
+ amount?: number;
22
+ amount_in_decimal?: string;
23
+ billing_period?: number;
24
+ billing_period_unit?: 'day' | 'week' | 'month' | 'year';
25
+ free_quantity?: number;
26
+ free_quantity_in_decimal?: string;
27
+ billing_cycles?: number;
28
+ service_period_days?: number;
29
+ charge_on_event?:
30
+ | 'subscription_creation'
31
+ | 'subscription_trial_start'
32
+ | 'plan_activation'
33
+ | 'subscription_activation'
34
+ | 'contract_termination';
35
+ charge_once?: boolean;
36
+ charge_on_option?: 'immediately' | 'on_event';
37
+ start_date?: number;
38
+ end_date?: number;
39
+ ramp_tier_id?: string;
40
+ discount_amount?: number;
41
+ md_discount_amount?: string;
42
+ item_level_discount_amount?: number;
43
+ md_item_level_discount_amount?: string;
44
+ discount_per_billing_cycle?: number;
45
+ discount_per_billing_cycle_in_decimal?: string;
46
+ item_level_discount_per_billing_cycle?: number;
47
+ item_level_discount_per_billing_cycle_in_decimal?: string;
48
+ net_amount?: number;
49
+ md_net_amount?: string;
50
+ amount_per_billing_cycle?: number;
51
+ amount_per_billing_cycle_in_decimal?: string;
52
+ net_amount_per_billing_cycle?: number;
53
+ net_amount_per_billing_cycle_in_decimal?: string;
54
+ }
55
+ export interface Discount {
56
+ id: string;
57
+ name: string;
58
+ invoice_name?: string;
59
+ type: 'fixed_amount' | 'percentage';
60
+ percentage?: number;
61
+ amount?: number;
62
+ duration_type: 'one_time' | 'forever' | 'limited_period';
63
+ entity_type:
64
+ | 'item_level_coupon'
65
+ | 'document_level_coupon'
66
+ | 'item_level_discount'
67
+ | 'document_level_discount';
68
+ entity_id?: string;
69
+ period?: number;
70
+ period_unit?: 'day' | 'week' | 'month' | 'year';
71
+ included_in_mrr: boolean;
72
+ apply_on: 'invoice_amount' | 'specific_item_price';
73
+ apply_on_item_type?: 'plan' | 'addon' | 'charge';
74
+ item_price_id?: string;
75
+ created_at: number;
76
+ updated_at?: number;
77
+ start_date?: number;
78
+ end_date?: number;
79
+ }
80
+ export interface ItemTier {
81
+ item_price_id: string;
82
+ starting_unit: number;
83
+ ending_unit?: number;
84
+ price: number;
85
+ starting_unit_in_decimal?: string;
86
+ ending_unit_in_decimal?: string;
87
+ price_in_decimal?: string;
88
+ ramp_tier_id?: string;
89
+ }
90
+ // REQUEST PARAMS
91
+ //---------------
92
+ }
93
+ }
@@ -887,6 +887,8 @@ declare module 'chargebee' {
887
887
  export interface ContractTermsForSubscriptionInputParam {
888
888
  limit?: number;
889
889
  offset?: string;
890
+ 'sort_by[asc]'?: string;
891
+ 'sort_by[desc]'?: string;
890
892
  }
891
893
  export interface ListDiscountsInputParam {
892
894
  limit?: number;