chargebee 3.0.0-beta.4 → 3.0.0-beta.5
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 +9 -0
- package/cjs/environment.js +1 -1
- package/cjs/util.js +1 -1
- package/esm/environment.js +1 -1
- package/esm/util.js +1 -1
- package/package.json +1 -1
- package/types/core.d.ts +88 -78
- package/types/resources/Address.d.ts +2 -2
- package/types/resources/AdvanceInvoiceSchedule.d.ts +1 -1
- package/types/resources/AttachedItem.d.ts +4 -4
- package/types/resources/Card.d.ts +3 -3
- package/types/resources/Comment.d.ts +2 -2
- package/types/resources/Coupon.d.ts +5 -5
- package/types/resources/CreditNote.d.ts +7 -7
- package/types/resources/CreditNoteEstimate.d.ts +1 -1
- package/types/resources/Customer.d.ts +46 -46
- package/types/resources/Discount.d.ts +3 -3
- package/types/resources/Entitlement.d.ts +1 -1
- package/types/resources/EntitlementOverride.d.ts +1 -1
- package/types/resources/Estimate.d.ts +100 -100
- package/types/resources/Event.d.ts +3 -3
- package/types/resources/Export.d.ts +4 -4
- package/types/resources/Gift.d.ts +2 -2
- package/types/resources/HostedPage.d.ts +64 -64
- package/types/resources/Invoice.d.ts +44 -44
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +5 -5
- package/types/resources/ItemEntitlement.d.ts +2 -2
- package/types/resources/ItemFamily.d.ts +1 -1
- package/types/resources/ItemPrice.d.ts +11 -11
- package/types/resources/Order.d.ts +6 -6
- package/types/resources/PaymentSource.d.ts +13 -13
- package/types/resources/PaymentVoucher.d.ts +9 -9
- package/types/resources/PricingPageSession.d.ts +8 -8
- package/types/resources/PromotionalCredit.d.ts +4 -4
- package/types/resources/Purchase.d.ts +6 -6
- package/types/resources/Quote.d.ts +83 -83
- package/types/resources/QuotedSubscription.d.ts +1 -1
- package/types/resources/Ramp.d.ts +6 -6
- package/types/resources/Subscription.d.ts +144 -144
- package/types/resources/SubscriptionEstimate.d.ts +2 -2
- package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -2
- package/types/resources/Token.d.ts +2 -2
- package/types/resources/Transaction.d.ts +3 -3
- package/types/resources/UnbilledCharge.d.ts +3 -3
- package/types/resources/Usage.d.ts +3 -3
- package/types/resources/VirtualBankAccount.d.ts +1 -1
|
@@ -214,7 +214,7 @@ declare module 'chargebee' {
|
|
|
214
214
|
billing_cycles?: number;
|
|
215
215
|
mandatory_addons_to_remove?: string[];
|
|
216
216
|
terms_to_charge?: number;
|
|
217
|
-
billing_alignment_mode?:
|
|
217
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
218
218
|
coupon_ids?: string[];
|
|
219
219
|
invoice_immediately?: boolean;
|
|
220
220
|
invoice_date?: number;
|
|
@@ -232,7 +232,7 @@ declare module 'chargebee' {
|
|
|
232
232
|
billing_cycles?: number;
|
|
233
233
|
mandatory_items_to_remove?: string[];
|
|
234
234
|
terms_to_charge?: number;
|
|
235
|
-
billing_alignment_mode?:
|
|
235
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
236
236
|
coupon_ids?: string[];
|
|
237
237
|
invoice_immediately?: boolean;
|
|
238
238
|
invoice_date?: number;
|
|
@@ -268,7 +268,7 @@ declare module 'chargebee' {
|
|
|
268
268
|
billing_cycles?: number;
|
|
269
269
|
mandatory_items_to_remove?: string[];
|
|
270
270
|
terms_to_charge?: number;
|
|
271
|
-
billing_alignment_mode?:
|
|
271
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
272
272
|
invoice_date?: number;
|
|
273
273
|
coupon_ids?: string[];
|
|
274
274
|
subscription?: SubscriptionCreateSubItemForCustomerEstimateInputParam;
|
|
@@ -281,14 +281,14 @@ declare module 'chargebee' {
|
|
|
281
281
|
}
|
|
282
282
|
export interface UpdateSubscriptionInputParam {
|
|
283
283
|
changes_scheduled_at?: number;
|
|
284
|
-
change_option?:
|
|
284
|
+
change_option?: ChangeOptionEnum;
|
|
285
285
|
replace_addon_list?: boolean;
|
|
286
286
|
mandatory_addons_to_remove?: string[];
|
|
287
287
|
invoice_date?: number;
|
|
288
288
|
billing_cycles?: number;
|
|
289
289
|
terms_to_charge?: number;
|
|
290
290
|
reactivate_from?: number;
|
|
291
|
-
billing_alignment_mode?:
|
|
291
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
292
292
|
coupon_ids?: string[];
|
|
293
293
|
replace_coupon_list?: boolean;
|
|
294
294
|
prorate?: boolean;
|
|
@@ -307,14 +307,14 @@ declare module 'chargebee' {
|
|
|
307
307
|
}
|
|
308
308
|
export interface UpdateSubscriptionForItemsInputParam {
|
|
309
309
|
changes_scheduled_at?: number;
|
|
310
|
-
change_option?:
|
|
310
|
+
change_option?: ChangeOptionEnum;
|
|
311
311
|
mandatory_items_to_remove?: string[];
|
|
312
312
|
replace_items_list?: boolean;
|
|
313
313
|
invoice_date?: number;
|
|
314
314
|
billing_cycles?: number;
|
|
315
315
|
terms_to_charge?: number;
|
|
316
316
|
reactivate_from?: number;
|
|
317
|
-
billing_alignment_mode?:
|
|
317
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
318
318
|
coupon_ids?: string[];
|
|
319
319
|
replace_coupon_list?: boolean;
|
|
320
320
|
prorate?: boolean;
|
|
@@ -342,7 +342,7 @@ declare module 'chargebee' {
|
|
|
342
342
|
export interface AdvanceInvoiceEstimateInputParam {
|
|
343
343
|
terms_to_charge?: number;
|
|
344
344
|
invoice_immediately?: boolean;
|
|
345
|
-
schedule_type?:
|
|
345
|
+
schedule_type?: ScheduleTypeEnum;
|
|
346
346
|
fixed_interval_schedule?: FixedIntervalScheduleAdvanceInvoiceEstimateInputParam;
|
|
347
347
|
specific_dates_schedule?: SpecificDatesScheduleAdvanceInvoiceEstimateInputParam[];
|
|
348
348
|
}
|
|
@@ -358,39 +358,39 @@ declare module 'chargebee' {
|
|
|
358
358
|
invoice_immediately?: boolean;
|
|
359
359
|
}
|
|
360
360
|
export interface CancelSubscriptionInputParam {
|
|
361
|
-
cancel_option?:
|
|
361
|
+
cancel_option?: CancelOptionEnum;
|
|
362
362
|
end_of_term?: boolean;
|
|
363
363
|
cancel_at?: number;
|
|
364
|
-
credit_option_for_current_term_charges?:
|
|
365
|
-
unbilled_charges_option?:
|
|
366
|
-
account_receivables_handling?:
|
|
367
|
-
refundable_credits_handling?:
|
|
368
|
-
contract_term_cancel_option?:
|
|
364
|
+
credit_option_for_current_term_charges?: CreditOptionForCurrentTermChargesEnum;
|
|
365
|
+
unbilled_charges_option?: UnbilledChargesOptionEnum;
|
|
366
|
+
account_receivables_handling?: AccountReceivablesHandlingEnum;
|
|
367
|
+
refundable_credits_handling?: RefundableCreditsHandlingEnum;
|
|
368
|
+
contract_term_cancel_option?: ContractTermCancelOptionEnum;
|
|
369
369
|
invoice_date?: number;
|
|
370
370
|
cancel_reason_code?: string;
|
|
371
371
|
event_based_addons?: EventBasedAddonsCancelSubscriptionInputParam[];
|
|
372
372
|
}
|
|
373
373
|
export interface CancelSubscriptionForItemsInputParam {
|
|
374
|
-
cancel_option?:
|
|
374
|
+
cancel_option?: CancelOptionEnum;
|
|
375
375
|
end_of_term?: boolean;
|
|
376
376
|
cancel_at?: number;
|
|
377
|
-
credit_option_for_current_term_charges?:
|
|
378
|
-
unbilled_charges_option?:
|
|
379
|
-
account_receivables_handling?:
|
|
380
|
-
refundable_credits_handling?:
|
|
381
|
-
contract_term_cancel_option?:
|
|
377
|
+
credit_option_for_current_term_charges?: CreditOptionForCurrentTermChargesEnum;
|
|
378
|
+
unbilled_charges_option?: UnbilledChargesOptionEnum;
|
|
379
|
+
account_receivables_handling?: AccountReceivablesHandlingEnum;
|
|
380
|
+
refundable_credits_handling?: RefundableCreditsHandlingEnum;
|
|
381
|
+
contract_term_cancel_option?: ContractTermCancelOptionEnum;
|
|
382
382
|
invoice_date?: number;
|
|
383
383
|
cancel_reason_code?: string;
|
|
384
384
|
subscription_items?: SubscriptionItemsCancelSubscriptionForItemsInputParam[];
|
|
385
385
|
}
|
|
386
386
|
export interface PauseSubscriptionInputParam {
|
|
387
|
-
pause_option?:
|
|
388
|
-
unbilled_charges_handling?:
|
|
387
|
+
pause_option?: PauseOptionEnum;
|
|
388
|
+
unbilled_charges_handling?: UnbilledChargesHandlingEnum;
|
|
389
389
|
subscription?: SubscriptionPauseSubscriptionInputParam;
|
|
390
390
|
}
|
|
391
391
|
export interface ResumeSubscriptionInputParam {
|
|
392
|
-
resume_option?:
|
|
393
|
-
charges_handling?:
|
|
392
|
+
resume_option?: ResumeOptionEnum;
|
|
393
|
+
charges_handling?: ChargesHandlingEnum;
|
|
394
394
|
subscription?: SubscriptionResumeSubscriptionInputParam;
|
|
395
395
|
}
|
|
396
396
|
export interface GiftSubscriptionInputParam {
|
|
@@ -423,7 +423,7 @@ declare module 'chargebee' {
|
|
|
423
423
|
coupon_ids?: string[];
|
|
424
424
|
authorization_transaction_id?: string;
|
|
425
425
|
payment_source_id?: string;
|
|
426
|
-
auto_collection?:
|
|
426
|
+
auto_collection?: AutoCollectionEnum;
|
|
427
427
|
invoice_date?: number;
|
|
428
428
|
invoice?: InvoiceCreateInvoiceInputParam;
|
|
429
429
|
shipping_address?: ShippingAddressCreateInvoiceInputParam;
|
|
@@ -443,7 +443,7 @@ declare module 'chargebee' {
|
|
|
443
443
|
coupon_ids?: string[];
|
|
444
444
|
authorization_transaction_id?: string;
|
|
445
445
|
payment_source_id?: string;
|
|
446
|
-
auto_collection?:
|
|
446
|
+
auto_collection?: AutoCollectionEnum;
|
|
447
447
|
invoice_date?: number;
|
|
448
448
|
invoice?: InvoiceCreateInvoiceForItemsInputParam;
|
|
449
449
|
shipping_address?: ShippingAddressCreateInvoiceForItemsInputParam;
|
|
@@ -468,17 +468,17 @@ declare module 'chargebee' {
|
|
|
468
468
|
state_code?: string;
|
|
469
469
|
zip?: string;
|
|
470
470
|
country?: string;
|
|
471
|
-
validation_status?:
|
|
471
|
+
validation_status?: ValidationStatusEnum;
|
|
472
472
|
}
|
|
473
473
|
export interface CustomerCreateSubscriptionInputParam {
|
|
474
474
|
vat_number?: string;
|
|
475
475
|
vat_number_prefix?: string;
|
|
476
476
|
registered_for_gst?: boolean;
|
|
477
|
-
taxability?:
|
|
478
|
-
entity_code?:
|
|
477
|
+
taxability?: TaxabilityEnum;
|
|
478
|
+
entity_code?: EntityCodeEnum;
|
|
479
479
|
exempt_number?: string;
|
|
480
480
|
exemption_details?: any;
|
|
481
|
-
customer_type?:
|
|
481
|
+
customer_type?: CustomerTypeEnum;
|
|
482
482
|
}
|
|
483
483
|
export interface ShippingAddressCreateSubscriptionInputParam {
|
|
484
484
|
line1?: string;
|
|
@@ -488,7 +488,7 @@ declare module 'chargebee' {
|
|
|
488
488
|
state_code?: string;
|
|
489
489
|
zip?: string;
|
|
490
490
|
country?: string;
|
|
491
|
-
validation_status?:
|
|
491
|
+
validation_status?: ValidationStatusEnum;
|
|
492
492
|
}
|
|
493
493
|
export interface ContractTermCreateSubscriptionInputParam {
|
|
494
494
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -508,11 +508,11 @@ declare module 'chargebee' {
|
|
|
508
508
|
* @deprecated Please refer API docs to use other attributes
|
|
509
509
|
*/
|
|
510
510
|
coupon?: string;
|
|
511
|
-
offline_payment_method?:
|
|
511
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
512
512
|
free_period?: number;
|
|
513
|
-
free_period_unit?:
|
|
513
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
514
514
|
contract_term_billing_cycle_on_renewal?: number;
|
|
515
|
-
trial_end_action?:
|
|
515
|
+
trial_end_action?: TrialEndActionEnum;
|
|
516
516
|
}
|
|
517
517
|
|
|
518
518
|
export interface EventBasedAddonsCreateSubscriptionInputParam {
|
|
@@ -522,9 +522,9 @@ declare module 'chargebee' {
|
|
|
522
522
|
quantity_in_decimal?: string;
|
|
523
523
|
unit_price_in_decimal?: string;
|
|
524
524
|
service_period_in_days?: number;
|
|
525
|
-
on_event?:
|
|
525
|
+
on_event?: OnEventEnum;
|
|
526
526
|
charge_once?: boolean;
|
|
527
|
-
charge_on?:
|
|
527
|
+
charge_on?: ChargeOnEnum;
|
|
528
528
|
}
|
|
529
529
|
export interface AddonsCreateSubscriptionInputParam {
|
|
530
530
|
id?: string;
|
|
@@ -548,17 +548,17 @@ declare module 'chargebee' {
|
|
|
548
548
|
state_code?: string;
|
|
549
549
|
zip?: string;
|
|
550
550
|
country?: string;
|
|
551
|
-
validation_status?:
|
|
551
|
+
validation_status?: ValidationStatusEnum;
|
|
552
552
|
}
|
|
553
553
|
export interface CustomerCreateSubItemEstimateInputParam {
|
|
554
554
|
vat_number?: string;
|
|
555
555
|
vat_number_prefix?: string;
|
|
556
556
|
registered_for_gst?: boolean;
|
|
557
|
-
taxability?:
|
|
558
|
-
entity_code?:
|
|
557
|
+
taxability?: TaxabilityEnum;
|
|
558
|
+
entity_code?: EntityCodeEnum;
|
|
559
559
|
exempt_number?: string;
|
|
560
560
|
exemption_details?: any;
|
|
561
|
-
customer_type?:
|
|
561
|
+
customer_type?: CustomerTypeEnum;
|
|
562
562
|
}
|
|
563
563
|
export interface ShippingAddressCreateSubItemEstimateInputParam {
|
|
564
564
|
line1?: string;
|
|
@@ -568,7 +568,7 @@ declare module 'chargebee' {
|
|
|
568
568
|
state_code?: string;
|
|
569
569
|
zip?: string;
|
|
570
570
|
country?: string;
|
|
571
|
-
validation_status?:
|
|
571
|
+
validation_status?: ValidationStatusEnum;
|
|
572
572
|
}
|
|
573
573
|
export interface ContractTermCreateSubItemEstimateInputParam {
|
|
574
574
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -591,9 +591,9 @@ declare module 'chargebee' {
|
|
|
591
591
|
*/
|
|
592
592
|
coupon?: string;
|
|
593
593
|
free_period?: number;
|
|
594
|
-
free_period_unit?:
|
|
594
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
595
595
|
contract_term_billing_cycle_on_renewal?: number;
|
|
596
|
-
trial_end_action?:
|
|
596
|
+
trial_end_action?: TrialEndActionEnum;
|
|
597
597
|
}
|
|
598
598
|
|
|
599
599
|
export interface SubscriptionItemsCreateSubItemEstimateInputParam {
|
|
@@ -605,21 +605,21 @@ declare module 'chargebee' {
|
|
|
605
605
|
billing_cycles?: number;
|
|
606
606
|
trial_end?: number;
|
|
607
607
|
service_period_days?: number;
|
|
608
|
-
charge_on_event?:
|
|
608
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
609
609
|
charge_once?: boolean;
|
|
610
610
|
/**
|
|
611
611
|
* @deprecated Please refer API docs to use other attributes
|
|
612
612
|
*/
|
|
613
|
-
item_type?:
|
|
614
|
-
charge_on_option?:
|
|
613
|
+
item_type?: ItemTypeEnum;
|
|
614
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
615
615
|
}
|
|
616
616
|
export interface DiscountsCreateSubItemEstimateInputParam {
|
|
617
|
-
apply_on:
|
|
618
|
-
duration_type:
|
|
617
|
+
apply_on: ApplyOnEnum;
|
|
618
|
+
duration_type: DurationTypeEnum;
|
|
619
619
|
percentage?: number;
|
|
620
620
|
amount?: number;
|
|
621
621
|
period?: number;
|
|
622
|
-
period_unit?:
|
|
622
|
+
period_unit?: PeriodUnitEnum;
|
|
623
623
|
included_in_mrr?: boolean;
|
|
624
624
|
item_price_id?: string;
|
|
625
625
|
}
|
|
@@ -645,7 +645,7 @@ declare module 'chargebee' {
|
|
|
645
645
|
state_code?: string;
|
|
646
646
|
zip?: string;
|
|
647
647
|
country?: string;
|
|
648
|
-
validation_status?:
|
|
648
|
+
validation_status?: ValidationStatusEnum;
|
|
649
649
|
}
|
|
650
650
|
export interface ContractTermCreateSubForCustomerEstimateInputParam {
|
|
651
651
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -661,11 +661,11 @@ declare module 'chargebee' {
|
|
|
661
661
|
setup_fee?: number;
|
|
662
662
|
trial_end?: number;
|
|
663
663
|
start_date?: number;
|
|
664
|
-
offline_payment_method?:
|
|
664
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
665
665
|
free_period?: number;
|
|
666
|
-
free_period_unit?:
|
|
666
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
667
667
|
contract_term_billing_cycle_on_renewal?: number;
|
|
668
|
-
trial_end_action?:
|
|
668
|
+
trial_end_action?: TrialEndActionEnum;
|
|
669
669
|
}
|
|
670
670
|
|
|
671
671
|
export interface EventBasedAddonsCreateSubForCustomerEstimateInputParam {
|
|
@@ -675,9 +675,9 @@ declare module 'chargebee' {
|
|
|
675
675
|
quantity_in_decimal?: string;
|
|
676
676
|
unit_price_in_decimal?: string;
|
|
677
677
|
service_period_in_days?: number;
|
|
678
|
-
on_event?:
|
|
678
|
+
on_event?: OnEventEnum;
|
|
679
679
|
charge_once?: boolean;
|
|
680
|
-
charge_on?:
|
|
680
|
+
charge_on?: ChargeOnEnum;
|
|
681
681
|
}
|
|
682
682
|
export interface AddonsCreateSubForCustomerEstimateInputParam {
|
|
683
683
|
id?: string;
|
|
@@ -696,7 +696,7 @@ declare module 'chargebee' {
|
|
|
696
696
|
state_code?: string;
|
|
697
697
|
zip?: string;
|
|
698
698
|
country?: string;
|
|
699
|
-
validation_status?:
|
|
699
|
+
validation_status?: ValidationStatusEnum;
|
|
700
700
|
}
|
|
701
701
|
export interface ShippingAddressCreateSubItemForCustomerEstimateInputParam {
|
|
702
702
|
line1?: string;
|
|
@@ -706,7 +706,7 @@ declare module 'chargebee' {
|
|
|
706
706
|
state_code?: string;
|
|
707
707
|
zip?: string;
|
|
708
708
|
country?: string;
|
|
709
|
-
validation_status?:
|
|
709
|
+
validation_status?: ValidationStatusEnum;
|
|
710
710
|
}
|
|
711
711
|
export interface ContractTermCreateSubItemForCustomerEstimateInputParam {
|
|
712
712
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -725,9 +725,9 @@ declare module 'chargebee' {
|
|
|
725
725
|
setup_fee?: number;
|
|
726
726
|
start_date?: number;
|
|
727
727
|
free_period?: number;
|
|
728
|
-
free_period_unit?:
|
|
728
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
729
729
|
contract_term_billing_cycle_on_renewal?: number;
|
|
730
|
-
trial_end_action?:
|
|
730
|
+
trial_end_action?: TrialEndActionEnum;
|
|
731
731
|
}
|
|
732
732
|
|
|
733
733
|
export interface SubscriptionItemsCreateSubItemForCustomerEstimateInputParam {
|
|
@@ -739,21 +739,21 @@ declare module 'chargebee' {
|
|
|
739
739
|
billing_cycles?: number;
|
|
740
740
|
trial_end?: number;
|
|
741
741
|
service_period_days?: number;
|
|
742
|
-
charge_on_event?:
|
|
742
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
743
743
|
charge_once?: boolean;
|
|
744
744
|
/**
|
|
745
745
|
* @deprecated Please refer API docs to use other attributes
|
|
746
746
|
*/
|
|
747
|
-
item_type?:
|
|
748
|
-
charge_on_option?:
|
|
747
|
+
item_type?: ItemTypeEnum;
|
|
748
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
749
749
|
}
|
|
750
750
|
export interface DiscountsCreateSubItemForCustomerEstimateInputParam {
|
|
751
|
-
apply_on:
|
|
752
|
-
duration_type:
|
|
751
|
+
apply_on: ApplyOnEnum;
|
|
752
|
+
duration_type: DurationTypeEnum;
|
|
753
753
|
percentage?: number;
|
|
754
754
|
amount?: number;
|
|
755
755
|
period?: number;
|
|
756
|
-
period_unit?:
|
|
756
|
+
period_unit?: PeriodUnitEnum;
|
|
757
757
|
included_in_mrr?: boolean;
|
|
758
758
|
item_price_id?: string;
|
|
759
759
|
}
|
|
@@ -774,7 +774,7 @@ declare module 'chargebee' {
|
|
|
774
774
|
state_code?: string;
|
|
775
775
|
zip?: string;
|
|
776
776
|
country?: string;
|
|
777
|
-
validation_status?:
|
|
777
|
+
validation_status?: ValidationStatusEnum;
|
|
778
778
|
}
|
|
779
779
|
export interface CustomerUpdateSubscriptionInputParam {
|
|
780
780
|
vat_number?: string;
|
|
@@ -783,7 +783,7 @@ declare module 'chargebee' {
|
|
|
783
783
|
/**
|
|
784
784
|
* @deprecated Please refer API docs to use other attributes
|
|
785
785
|
*/
|
|
786
|
-
taxability?:
|
|
786
|
+
taxability?: TaxabilityEnum;
|
|
787
787
|
}
|
|
788
788
|
export interface ShippingAddressUpdateSubscriptionInputParam {
|
|
789
789
|
line1?: string;
|
|
@@ -793,7 +793,7 @@ declare module 'chargebee' {
|
|
|
793
793
|
state_code?: string;
|
|
794
794
|
zip?: string;
|
|
795
795
|
country?: string;
|
|
796
|
-
validation_status?:
|
|
796
|
+
validation_status?: ValidationStatusEnum;
|
|
797
797
|
}
|
|
798
798
|
export interface SubscriptionUpdateSubscriptionInputParam {
|
|
799
799
|
id: string;
|
|
@@ -809,11 +809,11 @@ declare module 'chargebee' {
|
|
|
809
809
|
* @deprecated Please refer API docs to use other attributes
|
|
810
810
|
*/
|
|
811
811
|
coupon?: string;
|
|
812
|
-
auto_collection?:
|
|
813
|
-
offline_payment_method?:
|
|
812
|
+
auto_collection?: AutoCollectionEnum;
|
|
813
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
814
814
|
free_period?: number;
|
|
815
|
-
free_period_unit?:
|
|
816
|
-
trial_end_action?:
|
|
815
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
816
|
+
trial_end_action?: TrialEndActionEnum;
|
|
817
817
|
}
|
|
818
818
|
|
|
819
819
|
export interface EventBasedAddonsUpdateSubscriptionInputParam {
|
|
@@ -821,8 +821,8 @@ declare module 'chargebee' {
|
|
|
821
821
|
quantity?: number;
|
|
822
822
|
unit_price?: number;
|
|
823
823
|
service_period_in_days?: number;
|
|
824
|
-
charge_on?:
|
|
825
|
-
on_event?:
|
|
824
|
+
charge_on?: ChargeOnEnum;
|
|
825
|
+
on_event?: OnEventEnum;
|
|
826
826
|
charge_once?: boolean;
|
|
827
827
|
quantity_in_decimal?: string;
|
|
828
828
|
unit_price_in_decimal?: string;
|
|
@@ -835,7 +835,7 @@ declare module 'chargebee' {
|
|
|
835
835
|
quantity_in_decimal?: string;
|
|
836
836
|
unit_price_in_decimal?: string;
|
|
837
837
|
trial_end?: number;
|
|
838
|
-
proration_type?:
|
|
838
|
+
proration_type?: ProrationTypeEnum;
|
|
839
839
|
}
|
|
840
840
|
export interface BillingAddressUpdateSubscriptionForItemsInputParam {
|
|
841
841
|
line1?: string;
|
|
@@ -845,7 +845,7 @@ declare module 'chargebee' {
|
|
|
845
845
|
state_code?: string;
|
|
846
846
|
zip?: string;
|
|
847
847
|
country?: string;
|
|
848
|
-
validation_status?:
|
|
848
|
+
validation_status?: ValidationStatusEnum;
|
|
849
849
|
}
|
|
850
850
|
export interface CustomerUpdateSubscriptionForItemsInputParam {
|
|
851
851
|
vat_number?: string;
|
|
@@ -854,7 +854,7 @@ declare module 'chargebee' {
|
|
|
854
854
|
/**
|
|
855
855
|
* @deprecated Please refer API docs to use other attributes
|
|
856
856
|
*/
|
|
857
|
-
taxability?:
|
|
857
|
+
taxability?: TaxabilityEnum;
|
|
858
858
|
}
|
|
859
859
|
export interface ShippingAddressUpdateSubscriptionForItemsInputParam {
|
|
860
860
|
line1?: string;
|
|
@@ -864,7 +864,7 @@ declare module 'chargebee' {
|
|
|
864
864
|
state_code?: string;
|
|
865
865
|
zip?: string;
|
|
866
866
|
country?: string;
|
|
867
|
-
validation_status?:
|
|
867
|
+
validation_status?: ValidationStatusEnum;
|
|
868
868
|
}
|
|
869
869
|
export interface SubscriptionUpdateSubscriptionForItemsInputParam {
|
|
870
870
|
id: string;
|
|
@@ -878,11 +878,11 @@ declare module 'chargebee' {
|
|
|
878
878
|
* @deprecated Please refer API docs to use other attributes
|
|
879
879
|
*/
|
|
880
880
|
coupon?: string;
|
|
881
|
-
auto_collection?:
|
|
882
|
-
offline_payment_method?:
|
|
881
|
+
auto_collection?: AutoCollectionEnum;
|
|
882
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
883
883
|
free_period?: number;
|
|
884
|
-
free_period_unit?:
|
|
885
|
-
trial_end_action?:
|
|
884
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
885
|
+
trial_end_action?: TrialEndActionEnum;
|
|
886
886
|
}
|
|
887
887
|
|
|
888
888
|
export interface SubscriptionItemsUpdateSubscriptionForItemsInputParam {
|
|
@@ -894,25 +894,25 @@ declare module 'chargebee' {
|
|
|
894
894
|
billing_cycles?: number;
|
|
895
895
|
trial_end?: number;
|
|
896
896
|
service_period_days?: number;
|
|
897
|
-
charge_on_event?:
|
|
897
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
898
898
|
charge_once?: boolean;
|
|
899
|
-
charge_on_option?:
|
|
899
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
900
900
|
/**
|
|
901
901
|
* @deprecated Please refer API docs to use other attributes
|
|
902
902
|
*/
|
|
903
|
-
item_type?:
|
|
904
|
-
proration_type?:
|
|
903
|
+
item_type?: ItemTypeEnum;
|
|
904
|
+
proration_type?: ProrationTypeEnum;
|
|
905
905
|
}
|
|
906
906
|
export interface DiscountsUpdateSubscriptionForItemsInputParam {
|
|
907
|
-
apply_on:
|
|
908
|
-
duration_type:
|
|
907
|
+
apply_on: ApplyOnEnum;
|
|
908
|
+
duration_type: DurationTypeEnum;
|
|
909
909
|
percentage?: number;
|
|
910
910
|
amount?: number;
|
|
911
911
|
period?: number;
|
|
912
|
-
period_unit?:
|
|
912
|
+
period_unit?: PeriodUnitEnum;
|
|
913
913
|
included_in_mrr?: boolean;
|
|
914
914
|
item_price_id?: string;
|
|
915
|
-
operation_type:
|
|
915
|
+
operation_type: OperationTypeEnum;
|
|
916
916
|
id?: string;
|
|
917
917
|
}
|
|
918
918
|
export interface ItemTiersUpdateSubscriptionForItemsInputParam {
|
|
@@ -927,7 +927,7 @@ declare module 'chargebee' {
|
|
|
927
927
|
export interface FixedIntervalScheduleAdvanceInvoiceEstimateInputParam {
|
|
928
928
|
number_of_occurrences?: number;
|
|
929
929
|
days_before_renewal?: number;
|
|
930
|
-
end_schedule_on?:
|
|
930
|
+
end_schedule_on?: EndScheduleOnEnum;
|
|
931
931
|
end_date?: number;
|
|
932
932
|
}
|
|
933
933
|
|
|
@@ -991,7 +991,7 @@ declare module 'chargebee' {
|
|
|
991
991
|
state?: string;
|
|
992
992
|
zip?: string;
|
|
993
993
|
country?: string;
|
|
994
|
-
validation_status?:
|
|
994
|
+
validation_status?: ValidationStatusEnum;
|
|
995
995
|
}
|
|
996
996
|
export interface PaymentIntentGiftSubscriptionInputParam {
|
|
997
997
|
id?: string;
|
|
@@ -1068,7 +1068,7 @@ declare module 'chargebee' {
|
|
|
1068
1068
|
state?: string;
|
|
1069
1069
|
zip?: string;
|
|
1070
1070
|
country?: string;
|
|
1071
|
-
validation_status?:
|
|
1071
|
+
validation_status?: ValidationStatusEnum;
|
|
1072
1072
|
}
|
|
1073
1073
|
export interface PaymentIntentGiftSubscriptionForItemsInputParam {
|
|
1074
1074
|
id?: string;
|
|
@@ -1127,7 +1127,7 @@ declare module 'chargebee' {
|
|
|
1127
1127
|
state?: string;
|
|
1128
1128
|
zip?: string;
|
|
1129
1129
|
country?: string;
|
|
1130
|
-
validation_status?:
|
|
1130
|
+
validation_status?: ValidationStatusEnum;
|
|
1131
1131
|
}
|
|
1132
1132
|
|
|
1133
1133
|
export interface ChargesCreateInvoiceInputParam {
|
|
@@ -1139,7 +1139,7 @@ declare module 'chargebee' {
|
|
|
1139
1139
|
avalara_tax_code?: string;
|
|
1140
1140
|
hsn_code?: string;
|
|
1141
1141
|
taxjar_product_code?: string;
|
|
1142
|
-
avalara_sale_type?:
|
|
1142
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1143
1143
|
avalara_transaction_type?: number;
|
|
1144
1144
|
avalara_service_type?: number;
|
|
1145
1145
|
date_from?: number;
|
|
@@ -1160,7 +1160,7 @@ declare module 'chargebee' {
|
|
|
1160
1160
|
field_value?: string;
|
|
1161
1161
|
}
|
|
1162
1162
|
export interface NotesToRemoveCreateInvoiceInputParam {
|
|
1163
|
-
entity_type?:
|
|
1163
|
+
entity_type?: EntityTypeEnum;
|
|
1164
1164
|
entity_id?: string;
|
|
1165
1165
|
}
|
|
1166
1166
|
export interface InvoiceCreateInvoiceForItemsInputParam {
|
|
@@ -1182,7 +1182,7 @@ declare module 'chargebee' {
|
|
|
1182
1182
|
state?: string;
|
|
1183
1183
|
zip?: string;
|
|
1184
1184
|
country?: string;
|
|
1185
|
-
validation_status?:
|
|
1185
|
+
validation_status?: ValidationStatusEnum;
|
|
1186
1186
|
}
|
|
1187
1187
|
|
|
1188
1188
|
export interface ChargesCreateInvoiceForItemsInputParam {
|
|
@@ -1194,7 +1194,7 @@ declare module 'chargebee' {
|
|
|
1194
1194
|
avalara_tax_code?: string;
|
|
1195
1195
|
hsn_code?: string;
|
|
1196
1196
|
taxjar_product_code?: string;
|
|
1197
|
-
avalara_sale_type?:
|
|
1197
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1198
1198
|
avalara_transaction_type?: number;
|
|
1199
1199
|
avalara_service_type?: number;
|
|
1200
1200
|
date_from?: number;
|
|
@@ -1203,7 +1203,7 @@ declare module 'chargebee' {
|
|
|
1203
1203
|
export interface DiscountsCreateInvoiceForItemsInputParam {
|
|
1204
1204
|
percentage?: number;
|
|
1205
1205
|
amount?: number;
|
|
1206
|
-
apply_on:
|
|
1206
|
+
apply_on: ApplyOnEnum;
|
|
1207
1207
|
item_price_id?: string;
|
|
1208
1208
|
}
|
|
1209
1209
|
export interface ItemTiersCreateInvoiceForItemsInputParam {
|
|
@@ -1230,7 +1230,7 @@ declare module 'chargebee' {
|
|
|
1230
1230
|
field_value?: string;
|
|
1231
1231
|
}
|
|
1232
1232
|
export interface NotesToRemoveCreateInvoiceForItemsInputParam {
|
|
1233
|
-
entity_type?:
|
|
1233
|
+
entity_type?: EntityTypeEnum;
|
|
1234
1234
|
entity_id?: string;
|
|
1235
1235
|
}
|
|
1236
1236
|
}
|
|
@@ -5,7 +5,7 @@ declare module 'chargebee' {
|
|
|
5
5
|
export interface Event {
|
|
6
6
|
id: string;
|
|
7
7
|
occurred_at: number;
|
|
8
|
-
source:
|
|
8
|
+
source: SourceEnum;
|
|
9
9
|
user?: string;
|
|
10
10
|
webhook_status:
|
|
11
11
|
| 'not_configured'
|
|
@@ -17,8 +17,8 @@ declare module 'chargebee' {
|
|
|
17
17
|
| 'not_applicable';
|
|
18
18
|
webhook_failure_reason?: string;
|
|
19
19
|
webhooks?: Event.Webhook[];
|
|
20
|
-
event_type?:
|
|
21
|
-
api_version?:
|
|
20
|
+
event_type?: EventTypeEnum;
|
|
21
|
+
api_version?: ApiVersionEnum;
|
|
22
22
|
origin_user?: string;
|
|
23
23
|
}
|
|
24
24
|
|
|
@@ -185,7 +185,7 @@ declare module 'chargebee' {
|
|
|
185
185
|
//---------------
|
|
186
186
|
|
|
187
187
|
export interface RevenueRecognitionInputParam {
|
|
188
|
-
report_by:
|
|
188
|
+
report_by: ReportByEnum;
|
|
189
189
|
currency_code?: string;
|
|
190
190
|
report_from_month: number;
|
|
191
191
|
report_from_year: number;
|
|
@@ -203,7 +203,7 @@ declare module 'chargebee' {
|
|
|
203
203
|
relationship?: RelationshipRevenueRecognitionInputParam;
|
|
204
204
|
}
|
|
205
205
|
export interface DeferredRevenueInputParam {
|
|
206
|
-
report_by:
|
|
206
|
+
report_by: ReportByEnum;
|
|
207
207
|
currency_code?: string;
|
|
208
208
|
report_from_month: number;
|
|
209
209
|
report_from_year: number;
|
|
@@ -233,13 +233,13 @@ declare module 'chargebee' {
|
|
|
233
233
|
coupon?: CouponCouponsInputParam;
|
|
234
234
|
}
|
|
235
235
|
export interface CustomersInputParam {
|
|
236
|
-
export_type?:
|
|
236
|
+
export_type?: ExportTypeEnum;
|
|
237
237
|
business_entity_id?: filter.String;
|
|
238
238
|
customer?: CustomerCustomersInputParam;
|
|
239
239
|
relationship?: RelationshipCustomersInputParam;
|
|
240
240
|
}
|
|
241
241
|
export interface SubscriptionsInputParam {
|
|
242
|
-
export_type?:
|
|
242
|
+
export_type?: ExportTypeEnum;
|
|
243
243
|
item_id?: filter.String;
|
|
244
244
|
item_price_id?: filter.String;
|
|
245
245
|
cancel_reason_code?: filter.String;
|
|
@@ -174,7 +174,7 @@ declare module 'chargebee' {
|
|
|
174
174
|
state?: string;
|
|
175
175
|
zip?: string;
|
|
176
176
|
country?: string;
|
|
177
|
-
validation_status?:
|
|
177
|
+
validation_status?: ValidationStatusEnum;
|
|
178
178
|
}
|
|
179
179
|
export interface PaymentIntentCreateInputParam {
|
|
180
180
|
id?: string;
|
|
@@ -245,7 +245,7 @@ declare module 'chargebee' {
|
|
|
245
245
|
state?: string;
|
|
246
246
|
zip?: string;
|
|
247
247
|
country?: string;
|
|
248
|
-
validation_status?:
|
|
248
|
+
validation_status?: ValidationStatusEnum;
|
|
249
249
|
}
|
|
250
250
|
export interface PaymentIntentCreateForItemsInputParam {
|
|
251
251
|
id?: string;
|