chargebee 3.0.0-beta.3 → 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 +37 -0
- package/cjs/environment.js +1 -1
- package/cjs/resources/api_endpoints.js +1 -0
- package/cjs/util.js +1 -1
- package/esm/environment.js +1 -1
- package/esm/resources/api_endpoints.js +1 -0
- package/esm/util.js +1 -1
- package/package.json +2 -2
- package/types/core.d.ts +93 -80
- package/types/index.d.ts +1 -0
- 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 +5 -3
- package/types/resources/Comment.d.ts +2 -2
- package/types/resources/Coupon.d.ts +10 -10
- 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 +116 -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 -8
- package/types/resources/Order.d.ts +6 -6
- package/types/resources/PaymentScheduleEstimate.d.ts +25 -0
- package/types/resources/PaymentScheduleScheme.d.ts +1 -0
- package/types/resources/PaymentSource.d.ts +18 -14
- package/types/resources/PaymentVoucher.d.ts +9 -9
- package/types/resources/PricingPageSession.d.ts +27 -2
- package/types/resources/PromotionalCredit.d.ts +4 -4
- package/types/resources/Purchase.d.ts +6 -6
- package/types/resources/Quote.d.ts +84 -83
- package/types/resources/QuotedSubscription.d.ts +4 -1
- package/types/resources/Ramp.d.ts +6 -6
- package/types/resources/Subscription.d.ts +147 -142
- 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
|
@@ -8,6 +8,7 @@ declare module 'chargebee' {
|
|
|
8
8
|
subscription_estimates?: SubscriptionEstimate[];
|
|
9
9
|
invoice_estimate?: InvoiceEstimate;
|
|
10
10
|
invoice_estimates?: InvoiceEstimate[];
|
|
11
|
+
payment_schedule_estimates?: PaymentScheduleEstimate[];
|
|
11
12
|
next_invoice_estimate?: InvoiceEstimate;
|
|
12
13
|
credit_note_estimates?: CreditNoteEstimate[];
|
|
13
14
|
unbilled_charge_estimates?: UnbilledCharge[];
|
|
@@ -119,6 +120,11 @@ declare module 'chargebee' {
|
|
|
119
120
|
input: CreateInvoiceForItemsInputParam,
|
|
120
121
|
headers?: ChargebeeRequestHeader,
|
|
121
122
|
): Promise<ChargebeeResponse<CreateInvoiceForItemsResponse>>;
|
|
123
|
+
|
|
124
|
+
paymentSchedules(
|
|
125
|
+
input: PaymentSchedulesInputParam,
|
|
126
|
+
headers?: ChargebeeRequestHeader,
|
|
127
|
+
): Promise<ChargebeeResponse<PaymentSchedulesResponse>>;
|
|
122
128
|
}
|
|
123
129
|
|
|
124
130
|
export interface CreateSubscriptionResponse {
|
|
@@ -197,6 +203,10 @@ declare module 'chargebee' {
|
|
|
197
203
|
estimate: Estimate;
|
|
198
204
|
}
|
|
199
205
|
|
|
206
|
+
export interface PaymentSchedulesResponse {
|
|
207
|
+
estimate: Estimate;
|
|
208
|
+
}
|
|
209
|
+
|
|
200
210
|
// REQUEST PARAMS
|
|
201
211
|
//---------------
|
|
202
212
|
|
|
@@ -204,7 +214,7 @@ declare module 'chargebee' {
|
|
|
204
214
|
billing_cycles?: number;
|
|
205
215
|
mandatory_addons_to_remove?: string[];
|
|
206
216
|
terms_to_charge?: number;
|
|
207
|
-
billing_alignment_mode?:
|
|
217
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
208
218
|
coupon_ids?: string[];
|
|
209
219
|
invoice_immediately?: boolean;
|
|
210
220
|
invoice_date?: number;
|
|
@@ -222,7 +232,7 @@ declare module 'chargebee' {
|
|
|
222
232
|
billing_cycles?: number;
|
|
223
233
|
mandatory_items_to_remove?: string[];
|
|
224
234
|
terms_to_charge?: number;
|
|
225
|
-
billing_alignment_mode?:
|
|
235
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
226
236
|
coupon_ids?: string[];
|
|
227
237
|
invoice_immediately?: boolean;
|
|
228
238
|
invoice_date?: number;
|
|
@@ -258,7 +268,7 @@ declare module 'chargebee' {
|
|
|
258
268
|
billing_cycles?: number;
|
|
259
269
|
mandatory_items_to_remove?: string[];
|
|
260
270
|
terms_to_charge?: number;
|
|
261
|
-
billing_alignment_mode?:
|
|
271
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
262
272
|
invoice_date?: number;
|
|
263
273
|
coupon_ids?: string[];
|
|
264
274
|
subscription?: SubscriptionCreateSubItemForCustomerEstimateInputParam;
|
|
@@ -271,14 +281,14 @@ declare module 'chargebee' {
|
|
|
271
281
|
}
|
|
272
282
|
export interface UpdateSubscriptionInputParam {
|
|
273
283
|
changes_scheduled_at?: number;
|
|
274
|
-
change_option?:
|
|
284
|
+
change_option?: ChangeOptionEnum;
|
|
275
285
|
replace_addon_list?: boolean;
|
|
276
286
|
mandatory_addons_to_remove?: string[];
|
|
277
287
|
invoice_date?: number;
|
|
278
288
|
billing_cycles?: number;
|
|
279
289
|
terms_to_charge?: number;
|
|
280
290
|
reactivate_from?: number;
|
|
281
|
-
billing_alignment_mode?:
|
|
291
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
282
292
|
coupon_ids?: string[];
|
|
283
293
|
replace_coupon_list?: boolean;
|
|
284
294
|
prorate?: boolean;
|
|
@@ -297,14 +307,14 @@ declare module 'chargebee' {
|
|
|
297
307
|
}
|
|
298
308
|
export interface UpdateSubscriptionForItemsInputParam {
|
|
299
309
|
changes_scheduled_at?: number;
|
|
300
|
-
change_option?:
|
|
310
|
+
change_option?: ChangeOptionEnum;
|
|
301
311
|
mandatory_items_to_remove?: string[];
|
|
302
312
|
replace_items_list?: boolean;
|
|
303
313
|
invoice_date?: number;
|
|
304
314
|
billing_cycles?: number;
|
|
305
315
|
terms_to_charge?: number;
|
|
306
316
|
reactivate_from?: number;
|
|
307
|
-
billing_alignment_mode?:
|
|
317
|
+
billing_alignment_mode?: BillingAlignmentModeEnum;
|
|
308
318
|
coupon_ids?: string[];
|
|
309
319
|
replace_coupon_list?: boolean;
|
|
310
320
|
prorate?: boolean;
|
|
@@ -332,7 +342,7 @@ declare module 'chargebee' {
|
|
|
332
342
|
export interface AdvanceInvoiceEstimateInputParam {
|
|
333
343
|
terms_to_charge?: number;
|
|
334
344
|
invoice_immediately?: boolean;
|
|
335
|
-
schedule_type?:
|
|
345
|
+
schedule_type?: ScheduleTypeEnum;
|
|
336
346
|
fixed_interval_schedule?: FixedIntervalScheduleAdvanceInvoiceEstimateInputParam;
|
|
337
347
|
specific_dates_schedule?: SpecificDatesScheduleAdvanceInvoiceEstimateInputParam[];
|
|
338
348
|
}
|
|
@@ -348,39 +358,39 @@ declare module 'chargebee' {
|
|
|
348
358
|
invoice_immediately?: boolean;
|
|
349
359
|
}
|
|
350
360
|
export interface CancelSubscriptionInputParam {
|
|
351
|
-
cancel_option?:
|
|
361
|
+
cancel_option?: CancelOptionEnum;
|
|
352
362
|
end_of_term?: boolean;
|
|
353
363
|
cancel_at?: number;
|
|
354
|
-
credit_option_for_current_term_charges?:
|
|
355
|
-
unbilled_charges_option?:
|
|
356
|
-
account_receivables_handling?:
|
|
357
|
-
refundable_credits_handling?:
|
|
358
|
-
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;
|
|
359
369
|
invoice_date?: number;
|
|
360
370
|
cancel_reason_code?: string;
|
|
361
371
|
event_based_addons?: EventBasedAddonsCancelSubscriptionInputParam[];
|
|
362
372
|
}
|
|
363
373
|
export interface CancelSubscriptionForItemsInputParam {
|
|
364
|
-
cancel_option?:
|
|
374
|
+
cancel_option?: CancelOptionEnum;
|
|
365
375
|
end_of_term?: boolean;
|
|
366
376
|
cancel_at?: number;
|
|
367
|
-
credit_option_for_current_term_charges?:
|
|
368
|
-
unbilled_charges_option?:
|
|
369
|
-
account_receivables_handling?:
|
|
370
|
-
refundable_credits_handling?:
|
|
371
|
-
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;
|
|
372
382
|
invoice_date?: number;
|
|
373
383
|
cancel_reason_code?: string;
|
|
374
384
|
subscription_items?: SubscriptionItemsCancelSubscriptionForItemsInputParam[];
|
|
375
385
|
}
|
|
376
386
|
export interface PauseSubscriptionInputParam {
|
|
377
|
-
pause_option?:
|
|
378
|
-
unbilled_charges_handling?:
|
|
387
|
+
pause_option?: PauseOptionEnum;
|
|
388
|
+
unbilled_charges_handling?: UnbilledChargesHandlingEnum;
|
|
379
389
|
subscription?: SubscriptionPauseSubscriptionInputParam;
|
|
380
390
|
}
|
|
381
391
|
export interface ResumeSubscriptionInputParam {
|
|
382
|
-
resume_option?:
|
|
383
|
-
charges_handling?:
|
|
392
|
+
resume_option?: ResumeOptionEnum;
|
|
393
|
+
charges_handling?: ChargesHandlingEnum;
|
|
384
394
|
subscription?: SubscriptionResumeSubscriptionInputParam;
|
|
385
395
|
}
|
|
386
396
|
export interface GiftSubscriptionInputParam {
|
|
@@ -413,7 +423,7 @@ declare module 'chargebee' {
|
|
|
413
423
|
coupon_ids?: string[];
|
|
414
424
|
authorization_transaction_id?: string;
|
|
415
425
|
payment_source_id?: string;
|
|
416
|
-
auto_collection?:
|
|
426
|
+
auto_collection?: AutoCollectionEnum;
|
|
417
427
|
invoice_date?: number;
|
|
418
428
|
invoice?: InvoiceCreateInvoiceInputParam;
|
|
419
429
|
shipping_address?: ShippingAddressCreateInvoiceInputParam;
|
|
@@ -433,7 +443,7 @@ declare module 'chargebee' {
|
|
|
433
443
|
coupon_ids?: string[];
|
|
434
444
|
authorization_transaction_id?: string;
|
|
435
445
|
payment_source_id?: string;
|
|
436
|
-
auto_collection?:
|
|
446
|
+
auto_collection?: AutoCollectionEnum;
|
|
437
447
|
invoice_date?: number;
|
|
438
448
|
invoice?: InvoiceCreateInvoiceForItemsInputParam;
|
|
439
449
|
shipping_address?: ShippingAddressCreateInvoiceForItemsInputParam;
|
|
@@ -444,6 +454,12 @@ declare module 'chargebee' {
|
|
|
444
454
|
discounts?: DiscountsCreateInvoiceForItemsInputParam[];
|
|
445
455
|
tax_providers_fields?: TaxProvidersFieldsCreateInvoiceForItemsInputParam[];
|
|
446
456
|
}
|
|
457
|
+
export interface PaymentSchedulesInputParam {
|
|
458
|
+
scheme_id: string;
|
|
459
|
+
amount?: number;
|
|
460
|
+
invoice_id?: string;
|
|
461
|
+
payment_schedule_start_date?: number;
|
|
462
|
+
}
|
|
447
463
|
export interface BillingAddressCreateSubscriptionInputParam {
|
|
448
464
|
line1?: string;
|
|
449
465
|
line2?: string;
|
|
@@ -452,17 +468,17 @@ declare module 'chargebee' {
|
|
|
452
468
|
state_code?: string;
|
|
453
469
|
zip?: string;
|
|
454
470
|
country?: string;
|
|
455
|
-
validation_status?:
|
|
471
|
+
validation_status?: ValidationStatusEnum;
|
|
456
472
|
}
|
|
457
473
|
export interface CustomerCreateSubscriptionInputParam {
|
|
458
474
|
vat_number?: string;
|
|
459
475
|
vat_number_prefix?: string;
|
|
460
476
|
registered_for_gst?: boolean;
|
|
461
|
-
taxability?:
|
|
462
|
-
entity_code?:
|
|
477
|
+
taxability?: TaxabilityEnum;
|
|
478
|
+
entity_code?: EntityCodeEnum;
|
|
463
479
|
exempt_number?: string;
|
|
464
480
|
exemption_details?: any;
|
|
465
|
-
customer_type?:
|
|
481
|
+
customer_type?: CustomerTypeEnum;
|
|
466
482
|
}
|
|
467
483
|
export interface ShippingAddressCreateSubscriptionInputParam {
|
|
468
484
|
line1?: string;
|
|
@@ -472,7 +488,7 @@ declare module 'chargebee' {
|
|
|
472
488
|
state_code?: string;
|
|
473
489
|
zip?: string;
|
|
474
490
|
country?: string;
|
|
475
|
-
validation_status?:
|
|
491
|
+
validation_status?: ValidationStatusEnum;
|
|
476
492
|
}
|
|
477
493
|
export interface ContractTermCreateSubscriptionInputParam {
|
|
478
494
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -492,11 +508,11 @@ declare module 'chargebee' {
|
|
|
492
508
|
* @deprecated Please refer API docs to use other attributes
|
|
493
509
|
*/
|
|
494
510
|
coupon?: string;
|
|
495
|
-
offline_payment_method?:
|
|
511
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
496
512
|
free_period?: number;
|
|
497
|
-
free_period_unit?:
|
|
513
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
498
514
|
contract_term_billing_cycle_on_renewal?: number;
|
|
499
|
-
trial_end_action?:
|
|
515
|
+
trial_end_action?: TrialEndActionEnum;
|
|
500
516
|
}
|
|
501
517
|
|
|
502
518
|
export interface EventBasedAddonsCreateSubscriptionInputParam {
|
|
@@ -506,9 +522,9 @@ declare module 'chargebee' {
|
|
|
506
522
|
quantity_in_decimal?: string;
|
|
507
523
|
unit_price_in_decimal?: string;
|
|
508
524
|
service_period_in_days?: number;
|
|
509
|
-
on_event?:
|
|
525
|
+
on_event?: OnEventEnum;
|
|
510
526
|
charge_once?: boolean;
|
|
511
|
-
charge_on?:
|
|
527
|
+
charge_on?: ChargeOnEnum;
|
|
512
528
|
}
|
|
513
529
|
export interface AddonsCreateSubscriptionInputParam {
|
|
514
530
|
id?: string;
|
|
@@ -532,17 +548,17 @@ declare module 'chargebee' {
|
|
|
532
548
|
state_code?: string;
|
|
533
549
|
zip?: string;
|
|
534
550
|
country?: string;
|
|
535
|
-
validation_status?:
|
|
551
|
+
validation_status?: ValidationStatusEnum;
|
|
536
552
|
}
|
|
537
553
|
export interface CustomerCreateSubItemEstimateInputParam {
|
|
538
554
|
vat_number?: string;
|
|
539
555
|
vat_number_prefix?: string;
|
|
540
556
|
registered_for_gst?: boolean;
|
|
541
|
-
taxability?:
|
|
542
|
-
entity_code?:
|
|
557
|
+
taxability?: TaxabilityEnum;
|
|
558
|
+
entity_code?: EntityCodeEnum;
|
|
543
559
|
exempt_number?: string;
|
|
544
560
|
exemption_details?: any;
|
|
545
|
-
customer_type?:
|
|
561
|
+
customer_type?: CustomerTypeEnum;
|
|
546
562
|
}
|
|
547
563
|
export interface ShippingAddressCreateSubItemEstimateInputParam {
|
|
548
564
|
line1?: string;
|
|
@@ -552,7 +568,7 @@ declare module 'chargebee' {
|
|
|
552
568
|
state_code?: string;
|
|
553
569
|
zip?: string;
|
|
554
570
|
country?: string;
|
|
555
|
-
validation_status?:
|
|
571
|
+
validation_status?: ValidationStatusEnum;
|
|
556
572
|
}
|
|
557
573
|
export interface ContractTermCreateSubItemEstimateInputParam {
|
|
558
574
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -575,9 +591,9 @@ declare module 'chargebee' {
|
|
|
575
591
|
*/
|
|
576
592
|
coupon?: string;
|
|
577
593
|
free_period?: number;
|
|
578
|
-
free_period_unit?:
|
|
594
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
579
595
|
contract_term_billing_cycle_on_renewal?: number;
|
|
580
|
-
trial_end_action?:
|
|
596
|
+
trial_end_action?: TrialEndActionEnum;
|
|
581
597
|
}
|
|
582
598
|
|
|
583
599
|
export interface SubscriptionItemsCreateSubItemEstimateInputParam {
|
|
@@ -589,21 +605,21 @@ declare module 'chargebee' {
|
|
|
589
605
|
billing_cycles?: number;
|
|
590
606
|
trial_end?: number;
|
|
591
607
|
service_period_days?: number;
|
|
592
|
-
charge_on_event?:
|
|
608
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
593
609
|
charge_once?: boolean;
|
|
594
610
|
/**
|
|
595
611
|
* @deprecated Please refer API docs to use other attributes
|
|
596
612
|
*/
|
|
597
|
-
item_type?:
|
|
598
|
-
charge_on_option?:
|
|
613
|
+
item_type?: ItemTypeEnum;
|
|
614
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
599
615
|
}
|
|
600
616
|
export interface DiscountsCreateSubItemEstimateInputParam {
|
|
601
|
-
apply_on:
|
|
602
|
-
duration_type:
|
|
617
|
+
apply_on: ApplyOnEnum;
|
|
618
|
+
duration_type: DurationTypeEnum;
|
|
603
619
|
percentage?: number;
|
|
604
620
|
amount?: number;
|
|
605
621
|
period?: number;
|
|
606
|
-
period_unit?:
|
|
622
|
+
period_unit?: PeriodUnitEnum;
|
|
607
623
|
included_in_mrr?: boolean;
|
|
608
624
|
item_price_id?: string;
|
|
609
625
|
}
|
|
@@ -629,7 +645,7 @@ declare module 'chargebee' {
|
|
|
629
645
|
state_code?: string;
|
|
630
646
|
zip?: string;
|
|
631
647
|
country?: string;
|
|
632
|
-
validation_status?:
|
|
648
|
+
validation_status?: ValidationStatusEnum;
|
|
633
649
|
}
|
|
634
650
|
export interface ContractTermCreateSubForCustomerEstimateInputParam {
|
|
635
651
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -645,11 +661,11 @@ declare module 'chargebee' {
|
|
|
645
661
|
setup_fee?: number;
|
|
646
662
|
trial_end?: number;
|
|
647
663
|
start_date?: number;
|
|
648
|
-
offline_payment_method?:
|
|
664
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
649
665
|
free_period?: number;
|
|
650
|
-
free_period_unit?:
|
|
666
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
651
667
|
contract_term_billing_cycle_on_renewal?: number;
|
|
652
|
-
trial_end_action?:
|
|
668
|
+
trial_end_action?: TrialEndActionEnum;
|
|
653
669
|
}
|
|
654
670
|
|
|
655
671
|
export interface EventBasedAddonsCreateSubForCustomerEstimateInputParam {
|
|
@@ -659,9 +675,9 @@ declare module 'chargebee' {
|
|
|
659
675
|
quantity_in_decimal?: string;
|
|
660
676
|
unit_price_in_decimal?: string;
|
|
661
677
|
service_period_in_days?: number;
|
|
662
|
-
on_event?:
|
|
678
|
+
on_event?: OnEventEnum;
|
|
663
679
|
charge_once?: boolean;
|
|
664
|
-
charge_on?:
|
|
680
|
+
charge_on?: ChargeOnEnum;
|
|
665
681
|
}
|
|
666
682
|
export interface AddonsCreateSubForCustomerEstimateInputParam {
|
|
667
683
|
id?: string;
|
|
@@ -680,7 +696,7 @@ declare module 'chargebee' {
|
|
|
680
696
|
state_code?: string;
|
|
681
697
|
zip?: string;
|
|
682
698
|
country?: string;
|
|
683
|
-
validation_status?:
|
|
699
|
+
validation_status?: ValidationStatusEnum;
|
|
684
700
|
}
|
|
685
701
|
export interface ShippingAddressCreateSubItemForCustomerEstimateInputParam {
|
|
686
702
|
line1?: string;
|
|
@@ -690,7 +706,7 @@ declare module 'chargebee' {
|
|
|
690
706
|
state_code?: string;
|
|
691
707
|
zip?: string;
|
|
692
708
|
country?: string;
|
|
693
|
-
validation_status?:
|
|
709
|
+
validation_status?: ValidationStatusEnum;
|
|
694
710
|
}
|
|
695
711
|
export interface ContractTermCreateSubItemForCustomerEstimateInputParam {
|
|
696
712
|
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
@@ -709,9 +725,9 @@ declare module 'chargebee' {
|
|
|
709
725
|
setup_fee?: number;
|
|
710
726
|
start_date?: number;
|
|
711
727
|
free_period?: number;
|
|
712
|
-
free_period_unit?:
|
|
728
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
713
729
|
contract_term_billing_cycle_on_renewal?: number;
|
|
714
|
-
trial_end_action?:
|
|
730
|
+
trial_end_action?: TrialEndActionEnum;
|
|
715
731
|
}
|
|
716
732
|
|
|
717
733
|
export interface SubscriptionItemsCreateSubItemForCustomerEstimateInputParam {
|
|
@@ -723,21 +739,21 @@ declare module 'chargebee' {
|
|
|
723
739
|
billing_cycles?: number;
|
|
724
740
|
trial_end?: number;
|
|
725
741
|
service_period_days?: number;
|
|
726
|
-
charge_on_event?:
|
|
742
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
727
743
|
charge_once?: boolean;
|
|
728
744
|
/**
|
|
729
745
|
* @deprecated Please refer API docs to use other attributes
|
|
730
746
|
*/
|
|
731
|
-
item_type?:
|
|
732
|
-
charge_on_option?:
|
|
747
|
+
item_type?: ItemTypeEnum;
|
|
748
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
733
749
|
}
|
|
734
750
|
export interface DiscountsCreateSubItemForCustomerEstimateInputParam {
|
|
735
|
-
apply_on:
|
|
736
|
-
duration_type:
|
|
751
|
+
apply_on: ApplyOnEnum;
|
|
752
|
+
duration_type: DurationTypeEnum;
|
|
737
753
|
percentage?: number;
|
|
738
754
|
amount?: number;
|
|
739
755
|
period?: number;
|
|
740
|
-
period_unit?:
|
|
756
|
+
period_unit?: PeriodUnitEnum;
|
|
741
757
|
included_in_mrr?: boolean;
|
|
742
758
|
item_price_id?: string;
|
|
743
759
|
}
|
|
@@ -758,7 +774,7 @@ declare module 'chargebee' {
|
|
|
758
774
|
state_code?: string;
|
|
759
775
|
zip?: string;
|
|
760
776
|
country?: string;
|
|
761
|
-
validation_status?:
|
|
777
|
+
validation_status?: ValidationStatusEnum;
|
|
762
778
|
}
|
|
763
779
|
export interface CustomerUpdateSubscriptionInputParam {
|
|
764
780
|
vat_number?: string;
|
|
@@ -767,7 +783,7 @@ declare module 'chargebee' {
|
|
|
767
783
|
/**
|
|
768
784
|
* @deprecated Please refer API docs to use other attributes
|
|
769
785
|
*/
|
|
770
|
-
taxability?:
|
|
786
|
+
taxability?: TaxabilityEnum;
|
|
771
787
|
}
|
|
772
788
|
export interface ShippingAddressUpdateSubscriptionInputParam {
|
|
773
789
|
line1?: string;
|
|
@@ -777,7 +793,7 @@ declare module 'chargebee' {
|
|
|
777
793
|
state_code?: string;
|
|
778
794
|
zip?: string;
|
|
779
795
|
country?: string;
|
|
780
|
-
validation_status?:
|
|
796
|
+
validation_status?: ValidationStatusEnum;
|
|
781
797
|
}
|
|
782
798
|
export interface SubscriptionUpdateSubscriptionInputParam {
|
|
783
799
|
id: string;
|
|
@@ -793,11 +809,11 @@ declare module 'chargebee' {
|
|
|
793
809
|
* @deprecated Please refer API docs to use other attributes
|
|
794
810
|
*/
|
|
795
811
|
coupon?: string;
|
|
796
|
-
auto_collection?:
|
|
797
|
-
offline_payment_method?:
|
|
812
|
+
auto_collection?: AutoCollectionEnum;
|
|
813
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
798
814
|
free_period?: number;
|
|
799
|
-
free_period_unit?:
|
|
800
|
-
trial_end_action?:
|
|
815
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
816
|
+
trial_end_action?: TrialEndActionEnum;
|
|
801
817
|
}
|
|
802
818
|
|
|
803
819
|
export interface EventBasedAddonsUpdateSubscriptionInputParam {
|
|
@@ -805,8 +821,8 @@ declare module 'chargebee' {
|
|
|
805
821
|
quantity?: number;
|
|
806
822
|
unit_price?: number;
|
|
807
823
|
service_period_in_days?: number;
|
|
808
|
-
charge_on?:
|
|
809
|
-
on_event?:
|
|
824
|
+
charge_on?: ChargeOnEnum;
|
|
825
|
+
on_event?: OnEventEnum;
|
|
810
826
|
charge_once?: boolean;
|
|
811
827
|
quantity_in_decimal?: string;
|
|
812
828
|
unit_price_in_decimal?: string;
|
|
@@ -819,7 +835,7 @@ declare module 'chargebee' {
|
|
|
819
835
|
quantity_in_decimal?: string;
|
|
820
836
|
unit_price_in_decimal?: string;
|
|
821
837
|
trial_end?: number;
|
|
822
|
-
proration_type?:
|
|
838
|
+
proration_type?: ProrationTypeEnum;
|
|
823
839
|
}
|
|
824
840
|
export interface BillingAddressUpdateSubscriptionForItemsInputParam {
|
|
825
841
|
line1?: string;
|
|
@@ -829,7 +845,7 @@ declare module 'chargebee' {
|
|
|
829
845
|
state_code?: string;
|
|
830
846
|
zip?: string;
|
|
831
847
|
country?: string;
|
|
832
|
-
validation_status?:
|
|
848
|
+
validation_status?: ValidationStatusEnum;
|
|
833
849
|
}
|
|
834
850
|
export interface CustomerUpdateSubscriptionForItemsInputParam {
|
|
835
851
|
vat_number?: string;
|
|
@@ -838,7 +854,7 @@ declare module 'chargebee' {
|
|
|
838
854
|
/**
|
|
839
855
|
* @deprecated Please refer API docs to use other attributes
|
|
840
856
|
*/
|
|
841
|
-
taxability?:
|
|
857
|
+
taxability?: TaxabilityEnum;
|
|
842
858
|
}
|
|
843
859
|
export interface ShippingAddressUpdateSubscriptionForItemsInputParam {
|
|
844
860
|
line1?: string;
|
|
@@ -848,7 +864,7 @@ declare module 'chargebee' {
|
|
|
848
864
|
state_code?: string;
|
|
849
865
|
zip?: string;
|
|
850
866
|
country?: string;
|
|
851
|
-
validation_status?:
|
|
867
|
+
validation_status?: ValidationStatusEnum;
|
|
852
868
|
}
|
|
853
869
|
export interface SubscriptionUpdateSubscriptionForItemsInputParam {
|
|
854
870
|
id: string;
|
|
@@ -862,11 +878,11 @@ declare module 'chargebee' {
|
|
|
862
878
|
* @deprecated Please refer API docs to use other attributes
|
|
863
879
|
*/
|
|
864
880
|
coupon?: string;
|
|
865
|
-
auto_collection?:
|
|
866
|
-
offline_payment_method?:
|
|
881
|
+
auto_collection?: AutoCollectionEnum;
|
|
882
|
+
offline_payment_method?: OfflinePaymentMethodEnum;
|
|
867
883
|
free_period?: number;
|
|
868
|
-
free_period_unit?:
|
|
869
|
-
trial_end_action?:
|
|
884
|
+
free_period_unit?: FreePeriodUnitEnum;
|
|
885
|
+
trial_end_action?: TrialEndActionEnum;
|
|
870
886
|
}
|
|
871
887
|
|
|
872
888
|
export interface SubscriptionItemsUpdateSubscriptionForItemsInputParam {
|
|
@@ -878,25 +894,25 @@ declare module 'chargebee' {
|
|
|
878
894
|
billing_cycles?: number;
|
|
879
895
|
trial_end?: number;
|
|
880
896
|
service_period_days?: number;
|
|
881
|
-
charge_on_event?:
|
|
897
|
+
charge_on_event?: ChargeOnEventEnum;
|
|
882
898
|
charge_once?: boolean;
|
|
883
|
-
charge_on_option?:
|
|
899
|
+
charge_on_option?: ChargeOnOptionEnum;
|
|
884
900
|
/**
|
|
885
901
|
* @deprecated Please refer API docs to use other attributes
|
|
886
902
|
*/
|
|
887
|
-
item_type?:
|
|
888
|
-
proration_type?:
|
|
903
|
+
item_type?: ItemTypeEnum;
|
|
904
|
+
proration_type?: ProrationTypeEnum;
|
|
889
905
|
}
|
|
890
906
|
export interface DiscountsUpdateSubscriptionForItemsInputParam {
|
|
891
|
-
apply_on:
|
|
892
|
-
duration_type:
|
|
907
|
+
apply_on: ApplyOnEnum;
|
|
908
|
+
duration_type: DurationTypeEnum;
|
|
893
909
|
percentage?: number;
|
|
894
910
|
amount?: number;
|
|
895
911
|
period?: number;
|
|
896
|
-
period_unit?:
|
|
912
|
+
period_unit?: PeriodUnitEnum;
|
|
897
913
|
included_in_mrr?: boolean;
|
|
898
914
|
item_price_id?: string;
|
|
899
|
-
operation_type:
|
|
915
|
+
operation_type: OperationTypeEnum;
|
|
900
916
|
id?: string;
|
|
901
917
|
}
|
|
902
918
|
export interface ItemTiersUpdateSubscriptionForItemsInputParam {
|
|
@@ -911,7 +927,7 @@ declare module 'chargebee' {
|
|
|
911
927
|
export interface FixedIntervalScheduleAdvanceInvoiceEstimateInputParam {
|
|
912
928
|
number_of_occurrences?: number;
|
|
913
929
|
days_before_renewal?: number;
|
|
914
|
-
end_schedule_on?:
|
|
930
|
+
end_schedule_on?: EndScheduleOnEnum;
|
|
915
931
|
end_date?: number;
|
|
916
932
|
}
|
|
917
933
|
|
|
@@ -975,7 +991,7 @@ declare module 'chargebee' {
|
|
|
975
991
|
state?: string;
|
|
976
992
|
zip?: string;
|
|
977
993
|
country?: string;
|
|
978
|
-
validation_status?:
|
|
994
|
+
validation_status?: ValidationStatusEnum;
|
|
979
995
|
}
|
|
980
996
|
export interface PaymentIntentGiftSubscriptionInputParam {
|
|
981
997
|
id?: string;
|
|
@@ -1052,7 +1068,7 @@ declare module 'chargebee' {
|
|
|
1052
1068
|
state?: string;
|
|
1053
1069
|
zip?: string;
|
|
1054
1070
|
country?: string;
|
|
1055
|
-
validation_status?:
|
|
1071
|
+
validation_status?: ValidationStatusEnum;
|
|
1056
1072
|
}
|
|
1057
1073
|
export interface PaymentIntentGiftSubscriptionForItemsInputParam {
|
|
1058
1074
|
id?: string;
|
|
@@ -1111,7 +1127,7 @@ declare module 'chargebee' {
|
|
|
1111
1127
|
state?: string;
|
|
1112
1128
|
zip?: string;
|
|
1113
1129
|
country?: string;
|
|
1114
|
-
validation_status?:
|
|
1130
|
+
validation_status?: ValidationStatusEnum;
|
|
1115
1131
|
}
|
|
1116
1132
|
|
|
1117
1133
|
export interface ChargesCreateInvoiceInputParam {
|
|
@@ -1123,7 +1139,7 @@ declare module 'chargebee' {
|
|
|
1123
1139
|
avalara_tax_code?: string;
|
|
1124
1140
|
hsn_code?: string;
|
|
1125
1141
|
taxjar_product_code?: string;
|
|
1126
|
-
avalara_sale_type?:
|
|
1142
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1127
1143
|
avalara_transaction_type?: number;
|
|
1128
1144
|
avalara_service_type?: number;
|
|
1129
1145
|
date_from?: number;
|
|
@@ -1144,7 +1160,7 @@ declare module 'chargebee' {
|
|
|
1144
1160
|
field_value?: string;
|
|
1145
1161
|
}
|
|
1146
1162
|
export interface NotesToRemoveCreateInvoiceInputParam {
|
|
1147
|
-
entity_type?:
|
|
1163
|
+
entity_type?: EntityTypeEnum;
|
|
1148
1164
|
entity_id?: string;
|
|
1149
1165
|
}
|
|
1150
1166
|
export interface InvoiceCreateInvoiceForItemsInputParam {
|
|
@@ -1166,7 +1182,7 @@ declare module 'chargebee' {
|
|
|
1166
1182
|
state?: string;
|
|
1167
1183
|
zip?: string;
|
|
1168
1184
|
country?: string;
|
|
1169
|
-
validation_status?:
|
|
1185
|
+
validation_status?: ValidationStatusEnum;
|
|
1170
1186
|
}
|
|
1171
1187
|
|
|
1172
1188
|
export interface ChargesCreateInvoiceForItemsInputParam {
|
|
@@ -1178,7 +1194,7 @@ declare module 'chargebee' {
|
|
|
1178
1194
|
avalara_tax_code?: string;
|
|
1179
1195
|
hsn_code?: string;
|
|
1180
1196
|
taxjar_product_code?: string;
|
|
1181
|
-
avalara_sale_type?:
|
|
1197
|
+
avalara_sale_type?: AvalaraSaleTypeEnum;
|
|
1182
1198
|
avalara_transaction_type?: number;
|
|
1183
1199
|
avalara_service_type?: number;
|
|
1184
1200
|
date_from?: number;
|
|
@@ -1187,7 +1203,7 @@ declare module 'chargebee' {
|
|
|
1187
1203
|
export interface DiscountsCreateInvoiceForItemsInputParam {
|
|
1188
1204
|
percentage?: number;
|
|
1189
1205
|
amount?: number;
|
|
1190
|
-
apply_on:
|
|
1206
|
+
apply_on: ApplyOnEnum;
|
|
1191
1207
|
item_price_id?: string;
|
|
1192
1208
|
}
|
|
1193
1209
|
export interface ItemTiersCreateInvoiceForItemsInputParam {
|
|
@@ -1214,7 +1230,7 @@ declare module 'chargebee' {
|
|
|
1214
1230
|
field_value?: string;
|
|
1215
1231
|
}
|
|
1216
1232
|
export interface NotesToRemoveCreateInvoiceForItemsInputParam {
|
|
1217
|
-
entity_type?:
|
|
1233
|
+
entity_type?: EntityTypeEnum;
|
|
1218
1234
|
entity_id?: string;
|
|
1219
1235
|
}
|
|
1220
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;
|