chargebee 2.51.0 → 2.52.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 +27 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +14 -1
- package/package.json +1 -1
- package/types/core.d.ts +4 -4
- package/types/index.d.ts +2 -0
- package/types/resources/Address.d.ts +2 -194
- package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
- package/types/resources/Attribute.d.ts +4 -1
- package/types/resources/BillingConfiguration.d.ts +21 -0
- package/types/resources/Brand.d.ts +12 -0
- package/types/resources/BusinessEntity.d.ts +8 -6
- package/types/resources/BusinessEntityTransfer.d.ts +10 -7
- package/types/resources/Card.d.ts +11 -311
- package/types/resources/Comment.d.ts +7 -124
- package/types/resources/Contact.d.ts +2 -44
- package/types/resources/ContractTerm.d.ts +4 -72
- package/types/resources/Coupon.d.ts +0 -37
- package/types/resources/CouponCode.d.ts +67 -35
- package/types/resources/CouponSet.d.ts +12 -121
- package/types/resources/CreditNote.d.ts +0 -6
- package/types/resources/Currency.d.ts +8 -5
- package/types/resources/Customer.d.ts +90 -89
- package/types/resources/Discount.d.ts +2 -89
- package/types/resources/Download.d.ts +2 -14
- package/types/resources/Entitlement.d.ts +15 -103
- package/types/resources/EntitlementOverride.d.ts +4 -89
- package/types/resources/Estimate.d.ts +2 -10
- package/types/resources/Event.d.ts +23 -108
- package/types/resources/Export.d.ts +116 -432
- package/types/resources/Feature.d.ts +17 -319
- package/types/resources/GatewayErrorDetail.d.ts +6 -48
- package/types/resources/Gift.d.ts +34 -294
- package/types/resources/Hierarchy.d.ts +4 -24
- package/types/resources/ImpactedItem.d.ts +4 -36
- package/types/resources/ImpactedItemPrice.d.ts +5 -2
- package/types/resources/ImpactedSubscription.d.ts +3 -30
- package/types/resources/InAppSubscription.d.ts +13 -355
- package/types/resources/Invoice.d.ts +2 -16
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +0 -7
- package/types/resources/ItemEntitlement.d.ts +15 -155
- package/types/resources/NonSubscription.d.ts +9 -6
- package/types/resources/PaymentIntent.d.ts +9 -255
- package/types/resources/PaymentReferenceNumber.d.ts +3 -20
- package/types/resources/PaymentSource.d.ts +2 -2
- package/types/resources/PaymentVoucher.d.ts +20 -203
- package/types/resources/PortalSession.d.ts +4 -146
- package/types/resources/PromotionalCredit.d.ts +10 -215
- package/types/resources/Purchase.d.ts +3 -1
- package/types/resources/Quote.d.ts +19 -1
- package/types/resources/QuotedRamp.d.ts +11 -16
- package/types/resources/RecordedPurchase.d.ts +2 -0
- package/types/resources/ResourceMigration.d.ts +2 -54
- package/types/resources/SiteMigrationDetail.d.ts +13 -55
- package/types/resources/Subscription.d.ts +11 -9
- package/types/resources/SubscriptionEntitlement.d.ts +6 -106
- package/types/resources/SubscriptionEstimate.d.ts +14 -11
- package/types/resources/TaxWithheld.d.ts +14 -26
- package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
- package/types/resources/TimeMachine.d.ts +3 -64
- package/types/resources/Token.d.ts +3 -60
- package/types/resources/Transaction.d.ts +2 -2
- package/types/resources/Usage.d.ts +21 -165
|
@@ -1,123 +1,81 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface SiteMigrationDetail {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description Id of the entity in this site.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
entity_id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Site name to which the record is moved in/out.
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
other_site_name:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description Entity Id of the record in the other site.
|
|
21
10
|
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
11
|
entity_id_at_other_site:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Date in which the record is copied
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
migrated_at:number;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description Entity Type of the record \* order - Entity that represents an order \* customer - Entity that represents a customer \* invoice - Invoice description \* subscription - Entity that represents a subscription of a customer \* transaction - Entity that represents a transaction. \* credit_note - Credit note description
|
|
35
14
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description Status of the migration \* moving_out - Moving out from one cb site to another \* moved_in - Moved in from another cb site \* moved_out - Moved out from one cb site to another
|
|
15
|
+
entity_type:'customer' | 'subscription' | 'invoice' | 'credit_note' | 'transaction' | 'order';
|
|
16
|
+
|
|
17
|
+
status:'moved_in' | 'moved_out' | 'moving_out';
|
|
42
18
|
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
|
-
status:'moving_out' | 'moved_in' | 'moved_out';
|
|
46
19
|
}
|
|
47
20
|
export namespace SiteMigrationDetail {
|
|
48
21
|
export class SiteMigrationDetailResource {
|
|
49
|
-
/**
|
|
50
|
-
* @description This endpoint lists the site migration details.
|
|
51
|
-
|
|
52
|
-
*/
|
|
53
|
-
|
|
54
22
|
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
55
23
|
}
|
|
56
24
|
export interface ListResponse {
|
|
57
|
-
/**
|
|
58
|
-
* @description This endpoint lists the site migration details.
|
|
59
|
-
|
|
60
|
-
*/
|
|
61
|
-
|
|
62
25
|
list:{site_migration_detail:SiteMigrationDetail}[];
|
|
63
26
|
|
|
64
|
-
/**
|
|
65
|
-
* @description This endpoint lists the site migration details.
|
|
66
|
-
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
27
|
next_offset?:string;
|
|
70
28
|
}
|
|
71
29
|
export interface ListInputParam {
|
|
72
30
|
[key : string]: any;
|
|
73
31
|
/**
|
|
74
|
-
* @description
|
|
32
|
+
* @description The number of resources to be returned.
|
|
75
33
|
|
|
76
34
|
*/
|
|
77
35
|
|
|
78
36
|
limit?:number;
|
|
79
37
|
|
|
80
38
|
/**
|
|
81
|
-
* @description
|
|
39
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
|
|
82
40
|
|
|
83
41
|
*/
|
|
84
42
|
|
|
85
43
|
offset?:string;
|
|
86
44
|
|
|
87
45
|
/**
|
|
88
|
-
* @description
|
|
46
|
+
* @description Entity Id of the record in the other site.
|
|
89
47
|
|
|
90
48
|
*/
|
|
91
49
|
|
|
92
50
|
entity_id_at_other_site?:{is?:string,is_not?:string,starts_with?:string};
|
|
93
51
|
|
|
94
52
|
/**
|
|
95
|
-
* @description
|
|
53
|
+
* @description Site name to which the record is moved in/out.
|
|
96
54
|
|
|
97
55
|
*/
|
|
98
56
|
|
|
99
57
|
other_site_name?:{is?:string,is_not?:string,starts_with?:string};
|
|
100
58
|
|
|
101
59
|
/**
|
|
102
|
-
* @description
|
|
60
|
+
* @description Id of the entity in this site.
|
|
103
61
|
|
|
104
62
|
*/
|
|
105
63
|
|
|
106
64
|
entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
107
65
|
|
|
108
66
|
/**
|
|
109
|
-
* @description
|
|
67
|
+
* @description Entity Type of the record
|
|
110
68
|
|
|
111
69
|
*/
|
|
112
70
|
|
|
113
|
-
entity_type?:{in?:string,is?:'
|
|
71
|
+
entity_type?:{in?:string,is?:'customer' | 'subscription' | 'invoice' | 'credit_note' | 'transaction' | 'order',is_not?:'customer' | 'subscription' | 'invoice' | 'credit_note' | 'transaction' | 'order',not_in?:string};
|
|
114
72
|
|
|
115
73
|
/**
|
|
116
|
-
* @description
|
|
74
|
+
* @description Status of the migration
|
|
117
75
|
|
|
118
76
|
*/
|
|
119
77
|
|
|
120
|
-
status?:{in?:string,is?:'
|
|
78
|
+
status?:{in?:string,is?:'moved_in' | 'moved_out' | 'moving_out',is_not?:'moved_in' | 'moved_out' | 'moving_out',not_in?:string};
|
|
121
79
|
}
|
|
122
80
|
|
|
123
81
|
}
|
|
@@ -262,7 +262,7 @@ declare module 'chargebee' {
|
|
|
262
262
|
|
|
263
263
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
264
264
|
|
|
265
|
-
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};
|
|
265
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
266
266
|
|
|
267
267
|
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};
|
|
268
268
|
|
|
@@ -361,7 +361,7 @@ declare module 'chargebee' {
|
|
|
361
361
|
|
|
362
362
|
statement_descriptor?:{descriptor?:string};
|
|
363
363
|
|
|
364
|
-
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};
|
|
364
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
365
365
|
|
|
366
366
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
367
367
|
|
|
@@ -448,7 +448,7 @@ declare module 'chargebee' {
|
|
|
448
448
|
|
|
449
449
|
statement_descriptor?:{descriptor?:string};
|
|
450
450
|
|
|
451
|
-
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};
|
|
451
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
452
452
|
|
|
453
453
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
|
|
454
454
|
|
|
@@ -548,8 +548,6 @@ declare module 'chargebee' {
|
|
|
548
548
|
|
|
549
549
|
include_deleted?:boolean;
|
|
550
550
|
|
|
551
|
-
include_deprecated?:boolean;
|
|
552
|
-
|
|
553
551
|
/**
|
|
554
552
|
* @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
|
|
555
553
|
|
|
@@ -797,7 +795,11 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
797
795
|
}
|
|
798
796
|
export interface RemoveScheduledCancellationInputParam {
|
|
799
797
|
|
|
798
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
799
|
+
|
|
800
800
|
billing_cycles?:number;
|
|
801
|
+
|
|
802
|
+
contract_term_billing_cycle_on_renewal?:number;
|
|
801
803
|
}
|
|
802
804
|
export interface RemoveCouponsResponse {
|
|
803
805
|
subscription:Subscription;
|
|
@@ -829,7 +831,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
829
831
|
|
|
830
832
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
831
833
|
|
|
832
|
-
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};
|
|
834
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
833
835
|
|
|
834
836
|
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};
|
|
835
837
|
|
|
@@ -938,7 +940,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
938
940
|
|
|
939
941
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
940
942
|
|
|
941
|
-
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};
|
|
943
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
942
944
|
|
|
943
945
|
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};
|
|
944
946
|
|
|
@@ -1070,7 +1072,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1070
1072
|
|
|
1071
1073
|
statement_descriptor?:{descriptor?:string};
|
|
1072
1074
|
|
|
1073
|
-
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};
|
|
1075
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
1074
1076
|
|
|
1075
1077
|
trial_end?:number;
|
|
1076
1078
|
|
|
@@ -1598,7 +1600,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1598
1600
|
}
|
|
1599
1601
|
export interface ResumeInputParam {
|
|
1600
1602
|
|
|
1601
|
-
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};
|
|
1603
|
+
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' | 'payconiq_by_bancontact',reference_id?:string};
|
|
1602
1604
|
|
|
1603
1605
|
resume_option?:ResumeOption;
|
|
1604
1606
|
|
|
@@ -3,141 +3,56 @@
|
|
|
3
3
|
declare module 'chargebee' {
|
|
4
4
|
export interface SubscriptionEntitlement {
|
|
5
5
|
|
|
6
|
-
/**
|
|
7
|
-
* @description The `id` of the [subscription](/docs/api/subscriptions) to which this entitlement belongs.
|
|
8
6
|
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
7
|
subscription_id:string;
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* @description The `id` of the [feature](/docs/api/features) towards which this subscription entitlement has been granted.
|
|
15
8
|
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
9
|
feature_id?:string;
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* @description The [name of the feature](/docs/api/features#feature_name) towards which this subscription entitlement has been granted.
|
|
22
10
|
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
11
|
feature_name?:string;
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* @description [The unit of measure](/docs/api/features#feature_unit) for the feature when its `type` is either `quantity` or `range`.
|
|
29
12
|
|
|
30
|
-
*/
|
|
31
|
-
|
|
32
13
|
feature_unit?:string;
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* @description The value denoting the effective entitlement level that the subscription has towards the feature. When `components.entitlement_override` is present, then this is the same as `components.entitlement_override.value`. Otherwise, it is `components.inherited_entitlements.value`.
|
|
36
14
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
value?:string;
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* @description The display name of the effective entitlement level. When `components.entitlement_override` is present, then this is the same as `components.entitlement_override.name`. Otherwise, it is derived based on the `type` of feature as follows:
|
|
15
|
+
feature_type?:string;
|
|
43
16
|
|
|
44
|
-
|
|
45
|
-
* When `feature.type` is `custom`: the `name` is the same as `inherited_entitlements.value`.
|
|
46
|
-
* When `feature.type` is `switch`: `name` is not applicable.
|
|
17
|
+
value?:string;
|
|
47
18
|
|
|
48
|
-
*/
|
|
49
|
-
|
|
50
19
|
name?:string;
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* @description Indicates that `components.entitlement_overrides` exists.
|
|
54
20
|
|
|
55
|
-
*/
|
|
56
|
-
|
|
57
21
|
is_overridden:boolean;
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* @description Indicates that `components.is_enabled` exists.
|
|
61
22
|
|
|
62
|
-
*/
|
|
63
|
-
|
|
64
23
|
is_enabled:boolean;
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* @description Timestamp when the subscription entitlements are going to expire.
|
|
68
24
|
|
|
69
|
-
*/
|
|
70
25
|
effective_from?:number;
|
|
71
26
|
|
|
72
27
|
schedule_status?:'activated' | 'scheduled' | 'failed';
|
|
73
28
|
|
|
74
29
|
expires_at?:number;
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* @description The component entitlements that constitute this `subscription_entitlement`. The effective entitlement [value](/docs/api/subscription_entitlements#subscription_entitlement_value) and [name](/docs/api/subscription_entitlements#subscription_entitlement_name) are determined from these component entitlements.
|
|
78
30
|
|
|
79
|
-
*/
|
|
80
|
-
|
|
81
31
|
components?:SubscriptionEntitlement.Component;
|
|
82
|
-
|
|
32
|
+
|
|
83
33
|
}
|
|
84
34
|
export namespace SubscriptionEntitlement {
|
|
85
35
|
export class SubscriptionEntitlementResource {
|
|
86
|
-
/**
|
|
87
|
-
* @description Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).
|
|
88
|
-
**Note:**
|
|
89
|
-
|
|
90
|
-
The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
|
|
91
|
-
|
|
92
|
-
*/
|
|
93
|
-
|
|
94
36
|
subscription_entitlements_for_subscription(subscription_id:string, input?:SubscriptionEntitlementsForSubscriptionInputParam):ChargebeeRequest<SubscriptionEntitlementsForSubscriptionResponse>;
|
|
95
37
|
|
|
96
|
-
/**
|
|
97
|
-
* @description Enables or disables specific `subscription_entitlements` for a subscription.
|
|
98
|
-
|
|
99
|
-
*/
|
|
100
|
-
|
|
101
38
|
set_subscription_entitlement_availability(subscription_id:string, input:SetSubscriptionEntitlementAvailabilityInputParam):ChargebeeRequest<SetSubscriptionEntitlementAvailabilityResponse>;
|
|
102
39
|
}
|
|
103
40
|
export interface SubscriptionEntitlementsForSubscriptionResponse {
|
|
104
|
-
/**
|
|
105
|
-
* @description Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).
|
|
106
|
-
**Note:**
|
|
107
|
-
|
|
108
|
-
The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
|
|
109
|
-
|
|
110
|
-
*/
|
|
111
|
-
|
|
112
41
|
list:{subscription_entitlement:SubscriptionEntitlement}[];
|
|
113
42
|
|
|
114
|
-
/**
|
|
115
|
-
* @description Retrieves the list of `subscription_entitlements` for the [subscription](/docs/api/subscriptions).
|
|
116
|
-
**Note:**
|
|
117
|
-
|
|
118
|
-
The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
|
|
119
|
-
|
|
120
|
-
*/
|
|
121
|
-
|
|
122
43
|
next_offset?:string;
|
|
123
44
|
}
|
|
124
45
|
export interface SubscriptionEntitlementsForSubscriptionInputParam {
|
|
125
46
|
[key : string]: any;
|
|
126
47
|
/**
|
|
127
|
-
* @description
|
|
128
|
-
**Note:**
|
|
129
|
-
|
|
130
|
-
The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
|
|
48
|
+
* @description The number of resources to be returned.
|
|
131
49
|
|
|
132
50
|
*/
|
|
133
51
|
|
|
134
52
|
limit?:number;
|
|
135
53
|
|
|
136
54
|
/**
|
|
137
|
-
* @description
|
|
138
|
-
**Note:**
|
|
139
|
-
|
|
140
|
-
The `components` attribute is not returned for any of the `subscription_entitlements`. Use the retrieve operation(coming soon) to obtain the `components`.
|
|
55
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
|
|
141
56
|
|
|
142
57
|
*/
|
|
143
58
|
|
|
@@ -154,26 +69,11 @@ The `components` attribute is not returned for any of the `subscr
|
|
|
154
69
|
}
|
|
155
70
|
export interface SetSubscriptionEntitlementAvailabilityInputParam {
|
|
156
71
|
|
|
157
|
-
|
|
158
|
-
* @description Specifies whether the `subscription_entitlements` are to be enabled or disabled.
|
|
159
|
-
|
|
160
|
-
*/
|
|
72
|
+
subscription_entitlements:{feature_id:string}[];
|
|
161
73
|
|
|
162
74
|
is_enabled:boolean;
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* @description Parameters for subscription_entitlements
|
|
166
|
-
|
|
167
|
-
*/
|
|
168
|
-
|
|
169
|
-
subscription_entitlements:{feature_id:string}[];
|
|
170
75
|
}
|
|
171
76
|
export interface Component {
|
|
172
|
-
/**
|
|
173
|
-
* @description When a subscription entitlement has been explicitly overridden, this object contains the details of said override. An `entitlement_override` can be [temporary](/docs/api/entitlement_overrides#entitlement_override_expires_at) such that it expires at some point in time and is no longer returned.
|
|
174
|
-
|
|
175
|
-
*/
|
|
176
|
-
|
|
177
77
|
entitlement_overrides?:EntitlementOverride;
|
|
178
78
|
}
|
|
179
79
|
}
|
|
@@ -1,24 +1,27 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface SubscriptionEstimate {
|
|
4
5
|
|
|
6
|
+
|
|
5
7
|
id?:string;
|
|
6
|
-
|
|
8
|
+
|
|
7
9
|
currency_code:string;
|
|
8
|
-
|
|
9
|
-
status?:'
|
|
10
|
-
|
|
10
|
+
|
|
11
|
+
status?:'future' | 'in_trial' | 'active' | 'non_renewing' | 'paused' | 'cancelled' | 'transferred';
|
|
12
|
+
|
|
11
13
|
trial_end_action?:TrialEndAction;
|
|
12
|
-
|
|
14
|
+
|
|
13
15
|
next_billing_at?:number;
|
|
14
|
-
|
|
16
|
+
|
|
15
17
|
pause_date?:number;
|
|
16
|
-
|
|
18
|
+
|
|
17
19
|
resume_date?:number;
|
|
18
|
-
|
|
20
|
+
|
|
19
21
|
shipping_address?:SubscriptionEstimate.ShippingAddress;
|
|
20
|
-
|
|
22
|
+
|
|
21
23
|
contract_term?:SubscriptionEstimate.ContractTerm;
|
|
24
|
+
|
|
22
25
|
}
|
|
23
26
|
export namespace SubscriptionEstimate {
|
|
24
27
|
|
|
@@ -57,7 +60,7 @@ declare module 'chargebee' {
|
|
|
57
60
|
export interface ContractTerm {
|
|
58
61
|
id:string;
|
|
59
62
|
|
|
60
|
-
status:'active' | '
|
|
63
|
+
status:'active' | 'completed' | 'cancelled' | 'terminated';
|
|
61
64
|
|
|
62
65
|
contract_start:number;
|
|
63
66
|
|
|
@@ -65,7 +68,7 @@ declare module 'chargebee' {
|
|
|
65
68
|
|
|
66
69
|
billing_cycle:number;
|
|
67
70
|
|
|
68
|
-
action_at_term_end:'
|
|
71
|
+
action_at_term_end:'renew' | 'evergreen' | 'cancel' | 'renew_once';
|
|
69
72
|
|
|
70
73
|
total_contract_value:number;
|
|
71
74
|
|
|
@@ -1,44 +1,32 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface TaxWithheld {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description An auto-generated unique identifier for the tax withheld. The value starts with the prefix `tax_wh_`. For example, `tax_wh_16BdDXSlbu4uV1Ee6`.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description A unique external reference number for the tax withheld. Typically, this is the reference number used by the system you are integrating the API with. Depending on your integration, this could be the reference number issued by the taxation authority to identify the customer or the specific tax transaction.
|
|
14
8
|
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
user?:string;
|
|
10
|
+
|
|
17
11
|
reference_number?:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The description for this tax withheld.
|
|
21
12
|
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
13
|
description?:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Date or time associated with the tax withheld.
|
|
28
14
|
|
|
29
|
-
|
|
30
|
-
|
|
15
|
+
type:'payment' | 'refund';
|
|
16
|
+
|
|
17
|
+
payment_method:'cash' | 'check' | 'chargeback' | 'bank_transfer' | 'other';
|
|
18
|
+
|
|
31
19
|
date?:number;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description The amount withheld by the customer as tax from the invoice. The unit depends on the [type of currency](/docs/api#md_disabled).
|
|
35
20
|
|
|
36
|
-
|
|
37
|
-
|
|
21
|
+
currency_code:string;
|
|
22
|
+
|
|
38
23
|
amount?:number;
|
|
39
|
-
|
|
24
|
+
|
|
40
25
|
resource_version?:number;
|
|
41
|
-
|
|
26
|
+
|
|
42
27
|
updated_at?:number;
|
|
28
|
+
|
|
29
|
+
exchange_rate?:number;
|
|
30
|
+
|
|
43
31
|
}
|
|
44
32
|
}
|
|
@@ -1,33 +1,16 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface ThirdPartyPaymentMethod {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description Type of the payment method. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* google_pay - Payments made via Google Pay. \* dotpay - Payments made via Dotpay. \* generic - Payments made via Generic Payment Method. \* giropay - Payments made via giropay. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* alipay - Payments made via Alipay. \* sofort - Payments made via Sofort. \* wechat_pay - Payments made via WeChat Pay. \* ideal - Payments made via iDEAL. \* netbanking_emandates - Netbanking (eMandates) Payments. \* upi - UPI Payments. \* bancontact - Payments made via Bancontact Card. \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* amazon_payments - Payments made via Amazon Payments. \* apple_pay - Payments made via Apple Pay.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
type:Type;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Name of the gateway this card is stored with. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
gateway:Gateway;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description The gateway account this payment method is stored with.
|
|
21
10
|
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
11
|
gateway_account_id?:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Identifier provided by the gateway to reference that specific card.
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
reference_id:string;
|
|
14
|
+
|
|
32
15
|
}
|
|
33
16
|
}
|