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
|
@@ -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 Customer {
|
|
4
5
|
[key : string] : any;
|
|
@@ -116,7 +117,7 @@ declare module 'chargebee' {
|
|
|
116
117
|
|
|
117
118
|
excess_payments:number;
|
|
118
119
|
|
|
119
|
-
balances?:Customer.
|
|
120
|
+
balances?:Customer.Balance[];
|
|
120
121
|
|
|
121
122
|
entity_identifiers?:Customer.EntityIdentifier[];
|
|
122
123
|
|
|
@@ -213,15 +214,15 @@ declare module 'chargebee' {
|
|
|
213
214
|
}
|
|
214
215
|
export interface CreateInputParam {
|
|
215
216
|
[key : string] : any;
|
|
216
|
-
card?:
|
|
217
|
+
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,tmp_token?:string};
|
|
217
218
|
|
|
218
|
-
bank_account?:
|
|
219
|
+
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
219
220
|
|
|
220
|
-
payment_method?:
|
|
221
|
+
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
221
222
|
|
|
222
|
-
payment_intent?:
|
|
223
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
223
224
|
|
|
224
|
-
billing_address?:
|
|
225
|
+
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};
|
|
225
226
|
|
|
226
227
|
entity_identifiers?:{id?:string,scheme?:string,standard?:string,value?:string}[];
|
|
227
228
|
|
|
@@ -321,7 +322,7 @@ declare module 'chargebee' {
|
|
|
321
322
|
|
|
322
323
|
*/
|
|
323
324
|
|
|
324
|
-
relationship?:{invoice_owner_id?:
|
|
325
|
+
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
325
326
|
|
|
326
327
|
/**
|
|
327
328
|
* @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \`deleted\` as \`true\`.
|
|
@@ -402,17 +403,6 @@ declare module 'chargebee' {
|
|
|
402
403
|
|
|
403
404
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
404
405
|
|
|
405
|
-
/**
|
|
406
|
-
* @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.
|
|
407
|
-
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
408
|
-
**Note**
|
|
409
|
-
|
|
410
|
-
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
411
|
-
|
|
412
|
-
*/
|
|
413
|
-
|
|
414
|
-
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
415
|
-
|
|
416
406
|
/**
|
|
417
407
|
* @description The preferred offline payment method for the customer.
|
|
418
408
|
|
|
@@ -434,6 +424,17 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
434
424
|
|
|
435
425
|
channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
|
|
436
426
|
|
|
427
|
+
/**
|
|
428
|
+
* @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.
|
|
429
|
+
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
430
|
+
**Note**
|
|
431
|
+
|
|
432
|
+
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
433
|
+
|
|
434
|
+
*/
|
|
435
|
+
|
|
436
|
+
business_entity_id?:{is?:string};
|
|
437
|
+
|
|
437
438
|
sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
438
439
|
}
|
|
439
440
|
export interface RetrieveResponse {
|
|
@@ -504,7 +505,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
504
505
|
}
|
|
505
506
|
export interface UpdatePaymentMethodInputParam {
|
|
506
507
|
|
|
507
|
-
payment_method:
|
|
508
|
+
payment_method:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type:Type};
|
|
508
509
|
}
|
|
509
510
|
export interface UpdateBillingInfoResponse {
|
|
510
511
|
customer:Customer;
|
|
@@ -513,7 +514,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
513
514
|
}
|
|
514
515
|
export interface UpdateBillingInfoInputParam {
|
|
515
516
|
|
|
516
|
-
billing_address?:
|
|
517
|
+
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};
|
|
517
518
|
|
|
518
519
|
entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
|
|
519
520
|
|
|
@@ -574,7 +575,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
574
575
|
}
|
|
575
576
|
export interface AddContactInputParam {
|
|
576
577
|
|
|
577
|
-
contact:
|
|
578
|
+
contact:{email:string,enabled?:boolean,first_name?:string,id?:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
|
|
578
579
|
}
|
|
579
580
|
export interface UpdateContactResponse {
|
|
580
581
|
customer:Customer;
|
|
@@ -583,7 +584,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
583
584
|
}
|
|
584
585
|
export interface UpdateContactInputParam {
|
|
585
586
|
|
|
586
|
-
contact:
|
|
587
|
+
contact:{email?:string,enabled?:boolean,first_name?:string,id:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
|
|
587
588
|
}
|
|
588
589
|
export interface DeleteContactResponse {
|
|
589
590
|
customer:Customer;
|
|
@@ -592,7 +593,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
592
593
|
}
|
|
593
594
|
export interface DeleteContactInputParam {
|
|
594
595
|
|
|
595
|
-
contact:
|
|
596
|
+
contact:{id:string};
|
|
596
597
|
}
|
|
597
598
|
export interface AddPromotionalCreditsResponse {
|
|
598
599
|
customer:Customer;
|
|
@@ -646,7 +647,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
646
647
|
}
|
|
647
648
|
export interface RecordExcessPaymentInputParam {
|
|
648
649
|
|
|
649
|
-
transaction:
|
|
650
|
+
transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
|
|
650
651
|
|
|
651
652
|
comment?:string;
|
|
652
653
|
}
|
|
@@ -657,11 +658,11 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
657
658
|
}
|
|
658
659
|
export interface CollectPaymentInputParam {
|
|
659
660
|
|
|
660
|
-
payment_method?:
|
|
661
|
+
payment_method?:{additional_information?:object,gateway_account_id?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
661
662
|
|
|
662
|
-
card?:
|
|
663
|
+
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
|
|
663
664
|
|
|
664
|
-
payment_intent?:
|
|
665
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
665
666
|
|
|
666
667
|
invoice_allocations:{allocation_amount?:number,invoice_id:string}[];
|
|
667
668
|
|
|
@@ -732,9 +733,9 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
732
733
|
}
|
|
733
734
|
export interface RelationshipsInputParam {
|
|
734
735
|
|
|
735
|
-
parent_account_access?:
|
|
736
|
+
parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
736
737
|
|
|
737
|
-
child_account_access?:
|
|
738
|
+
child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
738
739
|
|
|
739
740
|
parent_id?:string;
|
|
740
741
|
|
|
@@ -760,9 +761,9 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
760
761
|
}
|
|
761
762
|
export interface UpdateHierarchySettingsInputParam {
|
|
762
763
|
|
|
763
|
-
parent_account_access?:
|
|
764
|
+
parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
764
765
|
|
|
765
|
-
child_account_access?:
|
|
766
|
+
child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
|
|
766
767
|
|
|
767
768
|
use_default_hierarchy_settings?:boolean;
|
|
768
769
|
}
|
|
@@ -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 Estimate {
|
|
4
5
|
|
|
@@ -63,15 +64,15 @@ declare module 'chargebee' {
|
|
|
63
64
|
}
|
|
64
65
|
export interface CreateSubscriptionInputParam {
|
|
65
66
|
|
|
66
|
-
subscription:
|
|
67
|
+
subscription:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,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,trial_end_action?:TrialEndAction};
|
|
67
68
|
|
|
68
|
-
billing_address?:
|
|
69
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
69
70
|
|
|
70
|
-
shipping_address?:
|
|
71
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
71
72
|
|
|
72
|
-
customer?:
|
|
73
|
+
customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
73
74
|
|
|
74
|
-
contract_term?:
|
|
75
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
75
76
|
|
|
76
77
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
77
78
|
|
|
@@ -100,15 +101,15 @@ declare module 'chargebee' {
|
|
|
100
101
|
}
|
|
101
102
|
export interface CreateSubItemEstimateInputParam {
|
|
102
103
|
|
|
103
|
-
subscription?:
|
|
104
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
104
105
|
|
|
105
|
-
billing_address?:
|
|
106
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
106
107
|
|
|
107
|
-
shipping_address?:
|
|
108
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
108
109
|
|
|
109
|
-
customer?:
|
|
110
|
+
customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
110
111
|
|
|
111
|
-
contract_term?:
|
|
112
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
|
|
112
113
|
|
|
113
114
|
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}[];
|
|
114
115
|
|
|
@@ -139,11 +140,11 @@ declare module 'chargebee' {
|
|
|
139
140
|
}
|
|
140
141
|
export interface CreateSubForCustomerEstimateInputParam {
|
|
141
142
|
|
|
142
|
-
subscription?:
|
|
143
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,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,trial_end_action?:TrialEndAction};
|
|
143
144
|
|
|
144
|
-
shipping_address?:
|
|
145
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
145
146
|
|
|
146
|
-
contract_term?:
|
|
147
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
147
148
|
|
|
148
149
|
addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
149
150
|
|
|
@@ -178,13 +179,13 @@ declare module 'chargebee' {
|
|
|
178
179
|
}
|
|
179
180
|
export interface CreateSubItemForCustomerEstimateInputParam {
|
|
180
181
|
|
|
181
|
-
subscription?:
|
|
182
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
182
183
|
|
|
183
|
-
shipping_address?:
|
|
184
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
184
185
|
|
|
185
|
-
billing_address?:
|
|
186
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
186
187
|
|
|
187
|
-
contract_term?:
|
|
188
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
|
|
188
189
|
|
|
189
190
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
190
191
|
|
|
@@ -213,13 +214,13 @@ declare module 'chargebee' {
|
|
|
213
214
|
}
|
|
214
215
|
export interface UpdateSubscriptionInputParam {
|
|
215
216
|
|
|
216
|
-
subscription:
|
|
217
|
+
subscription:{auto_collection?:AutoCollection,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,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,trial_end_action?:TrialEndAction};
|
|
217
218
|
|
|
218
|
-
billing_address?:
|
|
219
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
219
220
|
|
|
220
|
-
shipping_address?:
|
|
221
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
221
222
|
|
|
222
|
-
customer?:
|
|
223
|
+
customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
223
224
|
|
|
224
225
|
addons?:{billing_cycles?:number,id?:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
225
226
|
|
|
@@ -266,13 +267,13 @@ declare module 'chargebee' {
|
|
|
266
267
|
}
|
|
267
268
|
export interface UpdateSubscriptionForItemsInputParam {
|
|
268
269
|
|
|
269
|
-
subscription:
|
|
270
|
+
subscription:{auto_collection?:AutoCollection,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
270
271
|
|
|
271
|
-
billing_address?:
|
|
272
|
+
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
272
273
|
|
|
273
|
-
shipping_address?:
|
|
274
|
+
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
274
275
|
|
|
275
|
-
customer?:
|
|
276
|
+
customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
276
277
|
|
|
277
278
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
278
279
|
|
|
@@ -334,7 +335,7 @@ declare module 'chargebee' {
|
|
|
334
335
|
}
|
|
335
336
|
export interface AdvanceInvoiceEstimateInputParam {
|
|
336
337
|
|
|
337
|
-
fixed_interval_schedule?:
|
|
338
|
+
fixed_interval_schedule?:{days_before_renewal?:number,end_date?:number,end_schedule_on?:EndScheduleOn,number_of_occurrences?:number};
|
|
338
339
|
|
|
339
340
|
specific_dates_schedule?:{date?:number,terms_to_charge?:number}[];
|
|
340
341
|
|
|
@@ -377,6 +378,8 @@ declare module 'chargebee' {
|
|
|
377
378
|
}
|
|
378
379
|
export interface CancelSubscriptionInputParam {
|
|
379
380
|
|
|
381
|
+
cancel_option?:CancelOption;
|
|
382
|
+
|
|
380
383
|
end_of_term?:boolean;
|
|
381
384
|
|
|
382
385
|
cancel_at?:number;
|
|
@@ -402,6 +405,8 @@ declare module 'chargebee' {
|
|
|
402
405
|
}
|
|
403
406
|
export interface CancelSubscriptionForItemsInputParam {
|
|
404
407
|
|
|
408
|
+
cancel_option?:CancelOption;
|
|
409
|
+
|
|
405
410
|
end_of_term?:boolean;
|
|
406
411
|
|
|
407
412
|
cancel_at?:number;
|
|
@@ -427,7 +432,7 @@ declare module 'chargebee' {
|
|
|
427
432
|
}
|
|
428
433
|
export interface PauseSubscriptionInputParam {
|
|
429
434
|
|
|
430
|
-
subscription?:
|
|
435
|
+
subscription?:{pause_date?:number,resume_date?:number,skip_billing_cycles?:number};
|
|
431
436
|
|
|
432
437
|
pause_option?:PauseOption;
|
|
433
438
|
|
|
@@ -438,7 +443,7 @@ declare module 'chargebee' {
|
|
|
438
443
|
}
|
|
439
444
|
export interface ResumeSubscriptionInputParam {
|
|
440
445
|
|
|
441
|
-
subscription?:
|
|
446
|
+
subscription?:{resume_date?:number};
|
|
442
447
|
|
|
443
448
|
resume_option?:ResumeOption;
|
|
444
449
|
|
|
@@ -449,17 +454,17 @@ declare module 'chargebee' {
|
|
|
449
454
|
}
|
|
450
455
|
export interface GiftSubscriptionInputParam {
|
|
451
456
|
|
|
452
|
-
gift?:
|
|
457
|
+
gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
|
|
453
458
|
|
|
454
|
-
gifter:
|
|
459
|
+
gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
455
460
|
|
|
456
|
-
gift_receiver:
|
|
461
|
+
gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
457
462
|
|
|
458
|
-
payment_intent?:
|
|
463
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
459
464
|
|
|
460
|
-
shipping_address?:
|
|
465
|
+
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};
|
|
461
466
|
|
|
462
|
-
subscription:
|
|
467
|
+
subscription:{plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
|
|
463
468
|
|
|
464
469
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
465
470
|
|
|
@@ -470,15 +475,15 @@ declare module 'chargebee' {
|
|
|
470
475
|
}
|
|
471
476
|
export interface GiftSubscriptionForItemsInputParam {
|
|
472
477
|
|
|
473
|
-
gift?:
|
|
478
|
+
gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
|
|
474
479
|
|
|
475
|
-
gifter:
|
|
480
|
+
gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
|
|
476
481
|
|
|
477
|
-
gift_receiver:
|
|
482
|
+
gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
|
|
478
483
|
|
|
479
|
-
payment_intent?:
|
|
484
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
480
485
|
|
|
481
|
-
shipping_address?:
|
|
486
|
+
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};
|
|
482
487
|
|
|
483
488
|
subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
484
489
|
|
|
@@ -489,9 +494,9 @@ declare module 'chargebee' {
|
|
|
489
494
|
}
|
|
490
495
|
export interface CreateInvoiceInputParam {
|
|
491
496
|
|
|
492
|
-
invoice?:
|
|
497
|
+
invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
|
|
493
498
|
|
|
494
|
-
shipping_address?:
|
|
499
|
+
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};
|
|
495
500
|
|
|
496
501
|
addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
497
502
|
|
|
@@ -524,9 +529,9 @@ declare module 'chargebee' {
|
|
|
524
529
|
}
|
|
525
530
|
export interface CreateInvoiceForItemsInputParam {
|
|
526
531
|
|
|
527
|
-
invoice?:
|
|
532
|
+
invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
|
|
528
533
|
|
|
529
|
-
shipping_address?:
|
|
534
|
+
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};
|
|
530
535
|
|
|
531
536
|
item_prices?:{date_from?:number,date_to?:number,item_price_id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
532
537
|
|
|
@@ -445,6 +445,10 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
445
445
|
*/
|
|
446
446
|
|
|
447
447
|
entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
|
|
448
|
+
|
|
449
|
+
change_option?:ChangeOption;
|
|
450
|
+
|
|
451
|
+
changes_scheduled_at?:number;
|
|
448
452
|
}
|
|
449
453
|
export interface CheckoutNewForItemsResponse {
|
|
450
454
|
hosted_page:HostedPage;
|
|
@@ -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 Invoice {
|
|
4
5
|
|
|
@@ -474,6 +475,7 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
|
|
|
474
475
|
|
|
475
476
|
linked_taxes_withheld?:Invoice.LinkedTaxWithheld[];
|
|
476
477
|
site_details_at_creation?:Invoice.SiteDetailsAtCreation;
|
|
478
|
+
tax_origin?:Invoice.TaxOrigin;
|
|
477
479
|
}
|
|
478
480
|
export namespace Invoice {
|
|
479
481
|
export class InvoiceResource {
|
|
@@ -3254,5 +3256,10 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
3254
3256
|
timezone?: string;
|
|
3255
3257
|
organization_address?: object;
|
|
3256
3258
|
}
|
|
3259
|
+
export interface TaxOrigin {
|
|
3260
|
+
country?:string;
|
|
3261
|
+
|
|
3262
|
+
registration_number?:string;
|
|
3263
|
+
}
|
|
3257
3264
|
}
|
|
3258
3265
|
}
|
|
@@ -56,7 +56,7 @@ declare module 'chargebee' {
|
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
59
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
59
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
62
|
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
@@ -226,7 +226,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
226
226
|
|
|
227
227
|
*/
|
|
228
228
|
|
|
229
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
229
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
230
230
|
|
|
231
231
|
/**
|
|
232
232
|
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
@@ -273,7 +273,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
273
273
|
|
|
274
274
|
*/
|
|
275
275
|
|
|
276
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
276
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
279
|
* @description The URL the customer will be directed to once 3DS verification is successful. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.
|
|
@@ -313,7 +313,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
313
313
|
|
|
314
314
|
*/
|
|
315
315
|
|
|
316
|
-
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card';
|
|
316
|
+
payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card' | 'online_banking_poland';
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
319
|
* @description Reference of PaymentIntent at gateway
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface PricingPageSession {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
id?:string;
|
|
8
|
+
|
|
9
|
+
url?:string;
|
|
10
|
+
|
|
11
|
+
created_at?:number;
|
|
12
|
+
|
|
13
|
+
expires_at?:number;
|
|
14
|
+
|
|
15
|
+
}
|
|
16
|
+
export namespace PricingPageSession {
|
|
17
|
+
export class PricingPageSessionResource {
|
|
18
|
+
create_for_new_subscription(input:CreateForNewSubscriptionInputParam):ChargebeeRequest<CreateForNewSubscriptionResponse>;
|
|
19
|
+
|
|
20
|
+
create_for_existing_subscription(input:CreateForExistingSubscriptionInputParam):ChargebeeRequest<CreateForExistingSubscriptionResponse>;
|
|
21
|
+
}
|
|
22
|
+
export interface CreateForNewSubscriptionResponse {
|
|
23
|
+
pricing_page_session:PricingPageSession;
|
|
24
|
+
}
|
|
25
|
+
export interface CreateForNewSubscriptionInputParam {
|
|
26
|
+
|
|
27
|
+
pricing_page:{id:string};
|
|
28
|
+
|
|
29
|
+
subscription?:object;
|
|
30
|
+
|
|
31
|
+
customer?:object;
|
|
32
|
+
|
|
33
|
+
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};
|
|
34
|
+
|
|
35
|
+
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};
|
|
36
|
+
|
|
37
|
+
redirect_url?:string;
|
|
38
|
+
|
|
39
|
+
business_entity_id?:string;
|
|
40
|
+
}
|
|
41
|
+
export interface CreateForExistingSubscriptionResponse {
|
|
42
|
+
pricing_page_session:PricingPageSession;
|
|
43
|
+
}
|
|
44
|
+
export interface CreateForExistingSubscriptionInputParam {
|
|
45
|
+
|
|
46
|
+
pricing_page:{id:string};
|
|
47
|
+
|
|
48
|
+
subscription:object;
|
|
49
|
+
|
|
50
|
+
redirect_url?:string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
}
|
|
54
|
+
}
|
|
@@ -250,6 +250,7 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
250
250
|
*/
|
|
251
251
|
|
|
252
252
|
contract_terms:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number,index:number}[];
|
|
253
|
+
statement_descriptor?:{descriptor?:string};
|
|
253
254
|
}
|
|
254
255
|
export interface EstimateResponse {
|
|
255
256
|
estimate:Estimate;
|