chargebee 2.36.0 → 2.38.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 +36 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +61 -1
- package/package.json +1 -1
- package/types/core.d.ts +53 -50
- package/types/index.d.ts +4 -3
- package/types/resources/BusinessEntity.d.ts +1 -0
- package/types/resources/CreditNote.d.ts +7 -0
- package/types/resources/CreditNoteEstimate.d.ts +11 -15
- package/types/resources/Currency.d.ts +78 -0
- package/types/resources/Customer.d.ts +32 -31
- package/types/resources/Estimate.d.ts +48 -43
- package/types/resources/HostedPage.d.ts +4 -0
- package/types/resources/InstallmentConfig.d.ts +1 -1
- package/types/resources/Invoice.d.ts +7 -0
- package/types/resources/PaymentIntent.d.ts +4 -4
- package/types/resources/PaymentSource.d.ts +1 -0
- package/types/resources/PricingPageSession.d.ts +54 -0
- package/types/resources/Purchase.d.ts +1 -0
- package/types/resources/Quote.d.ts +38 -38
- package/types/resources/Subscription.d.ts +3 -8
- package/types/resources/UnbilledCharge.d.ts +2 -1
- package/types/resources/Usage.d.ts +1 -0
- package/types/resources/VirtualBankAccount.d.ts +1 -0
|
@@ -135,11 +135,11 @@ declare module 'chargebee' {
|
|
|
135
135
|
}
|
|
136
136
|
export interface CreateSubForCustomerQuoteInputParam {
|
|
137
137
|
|
|
138
|
-
subscription:
|
|
138
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
139
139
|
|
|
140
|
-
shipping_address?:
|
|
140
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
141
141
|
|
|
142
|
-
contract_term?:
|
|
142
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
143
143
|
|
|
144
144
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
145
145
|
|
|
@@ -168,11 +168,11 @@ declare module 'chargebee' {
|
|
|
168
168
|
}
|
|
169
169
|
export interface EditCreateSubForCustomerQuoteInputParam {
|
|
170
170
|
|
|
171
|
-
subscription:
|
|
171
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
172
172
|
|
|
173
|
-
shipping_address?:
|
|
173
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
174
174
|
|
|
175
|
-
contract_term?:
|
|
175
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
176
176
|
|
|
177
177
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
178
178
|
|
|
@@ -199,15 +199,15 @@ declare module 'chargebee' {
|
|
|
199
199
|
}
|
|
200
200
|
export interface UpdateSubscriptionQuoteInputParam {
|
|
201
201
|
|
|
202
|
-
subscription:
|
|
202
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
203
203
|
|
|
204
|
-
billing_address?:
|
|
204
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
205
205
|
|
|
206
|
-
shipping_address?:
|
|
206
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
207
207
|
|
|
208
|
-
customer?:
|
|
208
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
209
209
|
|
|
210
|
-
contract_term?:
|
|
210
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
211
211
|
|
|
212
212
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
213
213
|
|
|
@@ -250,15 +250,15 @@ declare module 'chargebee' {
|
|
|
250
250
|
}
|
|
251
251
|
export interface EditUpdateSubscriptionQuoteInputParam {
|
|
252
252
|
|
|
253
|
-
subscription?:
|
|
253
|
+
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
254
254
|
|
|
255
|
-
billing_address?:
|
|
255
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
256
256
|
|
|
257
|
-
shipping_address?:
|
|
257
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
258
258
|
|
|
259
|
-
customer?:
|
|
259
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
260
260
|
|
|
261
|
-
contract_term?:
|
|
261
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
262
262
|
|
|
263
263
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
264
264
|
|
|
@@ -299,7 +299,7 @@ declare module 'chargebee' {
|
|
|
299
299
|
}
|
|
300
300
|
export interface CreateForOnetimeChargesInputParam {
|
|
301
301
|
|
|
302
|
-
shipping_address?:
|
|
302
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
303
303
|
|
|
304
304
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
305
305
|
|
|
@@ -330,7 +330,7 @@ declare module 'chargebee' {
|
|
|
330
330
|
}
|
|
331
331
|
export interface EditOneTimeQuoteInputParam {
|
|
332
332
|
|
|
333
|
-
shipping_address?:
|
|
333
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
334
334
|
|
|
335
335
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
336
336
|
|
|
@@ -357,11 +357,11 @@ declare module 'chargebee' {
|
|
|
357
357
|
}
|
|
358
358
|
export interface CreateSubItemsForCustomerQuoteInputParam {
|
|
359
359
|
|
|
360
|
-
subscription?:
|
|
360
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
361
361
|
|
|
362
|
-
shipping_address?:
|
|
362
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
363
363
|
|
|
364
|
-
contract_term?:
|
|
364
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
365
365
|
|
|
366
366
|
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}[];
|
|
367
367
|
|
|
@@ -392,11 +392,11 @@ declare module 'chargebee' {
|
|
|
392
392
|
}
|
|
393
393
|
export interface EditCreateSubCustomerQuoteForItemsInputParam {
|
|
394
394
|
|
|
395
|
-
subscription?:
|
|
395
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
396
396
|
|
|
397
|
-
shipping_address?:
|
|
397
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
398
398
|
|
|
399
|
-
contract_term?:
|
|
399
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
400
400
|
|
|
401
401
|
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}[];
|
|
402
402
|
|
|
@@ -425,15 +425,15 @@ declare module 'chargebee' {
|
|
|
425
425
|
}
|
|
426
426
|
export interface UpdateSubscriptionQuoteForItemsInputParam {
|
|
427
427
|
|
|
428
|
-
subscription:
|
|
428
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
429
429
|
|
|
430
|
-
billing_address?:
|
|
430
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
431
431
|
|
|
432
|
-
shipping_address?:
|
|
432
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
433
433
|
|
|
434
|
-
customer?:
|
|
434
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
435
435
|
|
|
436
|
-
contract_term?:
|
|
436
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
437
437
|
|
|
438
438
|
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}[];
|
|
439
439
|
|
|
@@ -478,15 +478,15 @@ declare module 'chargebee' {
|
|
|
478
478
|
}
|
|
479
479
|
export interface EditUpdateSubscriptionQuoteForItemsInputParam {
|
|
480
480
|
|
|
481
|
-
subscription?:
|
|
481
|
+
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
482
482
|
|
|
483
|
-
billing_address?:
|
|
483
|
+
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
484
484
|
|
|
485
|
-
shipping_address?:
|
|
485
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
486
486
|
|
|
487
|
-
customer?:
|
|
487
|
+
customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
488
488
|
|
|
489
|
-
contract_term?:
|
|
489
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
|
|
490
490
|
|
|
491
491
|
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}[];
|
|
492
492
|
|
|
@@ -529,7 +529,7 @@ declare module 'chargebee' {
|
|
|
529
529
|
}
|
|
530
530
|
export interface CreateForChargeItemsAndChargesInputParam {
|
|
531
531
|
|
|
532
|
-
shipping_address?:
|
|
532
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
533
533
|
|
|
534
534
|
item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
535
535
|
|
|
@@ -564,7 +564,7 @@ declare module 'chargebee' {
|
|
|
564
564
|
}
|
|
565
565
|
export interface EditForChargeItemsAndChargesInputParam {
|
|
566
566
|
|
|
567
|
-
shipping_address?:
|
|
567
|
+
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
568
568
|
|
|
569
569
|
item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
570
570
|
|
|
@@ -701,7 +701,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
701
701
|
}
|
|
702
702
|
export interface ConvertInputParam {
|
|
703
703
|
|
|
704
|
-
subscription?:
|
|
704
|
+
subscription?:{auto_close_invoices?:boolean,auto_collection?:AutoCollection,id?:string,po_number?:string};
|
|
705
705
|
|
|
706
706
|
invoice_date?:number;
|
|
707
707
|
|
|
@@ -794,7 +794,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
794
794
|
|
|
795
795
|
entity_description?:string;
|
|
796
796
|
|
|
797
|
-
entity_type:'
|
|
797
|
+
entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon';
|
|
798
798
|
|
|
799
799
|
tax_exempt_reason?:'tax_not_configured' | 'region_non_taxable' | 'export' | 'customer_exempt' | 'product_exempt' | 'zero_rated' | 'reverse_charge' | 'high_value_physical_goods' | 'zero_value_item' | 'tax_not_configured_external_provider';
|
|
800
800
|
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
|
|
2
4
|
declare module 'chargebee' {
|
|
3
5
|
export interface Subscription {
|
|
4
6
|
[key : string] : any;
|
|
@@ -433,14 +435,7 @@ Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_bi
|
|
|
433
435
|
*/
|
|
434
436
|
|
|
435
437
|
referral_info?:Subscription.ReferralInfo;
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* @description Contract terms for this subscription
|
|
439
|
-
|
|
440
|
-
*/
|
|
441
|
-
|
|
442
|
-
contract_term?:Subscription.ContractTerm;
|
|
443
|
-
|
|
438
|
+
|
|
444
439
|
/**
|
|
445
440
|
* @description List of discounts for this subscription
|
|
446
441
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface UnbilledCharge {
|
|
4
5
|
|
|
@@ -42,7 +43,7 @@ declare module 'chargebee' {
|
|
|
42
43
|
|
|
43
44
|
updated_at:number;
|
|
44
45
|
|
|
45
|
-
tiers?:UnbilledCharge.
|
|
46
|
+
tiers?:UnbilledCharge.Tier[];
|
|
46
47
|
|
|
47
48
|
is_advance_charge?:boolean;
|
|
48
49
|
|