chargebee 2.50.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 +92 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +37 -1
- package/package.json +1 -1
- package/types/core.d.ts +8 -5
- package/types/index.d.ts +3 -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/Configuration.d.ts +2 -0
- 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 +2 -6
- package/types/resources/CreditNoteEstimate.d.ts +1 -1
- 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 +6 -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 +26 -18
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +4 -9
- package/types/resources/ItemEntitlement.d.ts +15 -155
- package/types/resources/NonSubscription.d.ts +9 -6
- package/types/resources/OmnichannelSubscriptionItem.d.ts +9 -0
- 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 +68 -18
- package/types/resources/QuoteLineGroup.d.ts +1 -1
- package/types/resources/QuotedRamp.d.ts +142 -0
- 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 +13 -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
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
declare module 'chargebee' {
|
|
4
|
+
export interface QuotedRamp {
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
id:string;
|
|
8
|
+
|
|
9
|
+
line_items?:QuotedRamp.LineItem[];
|
|
10
|
+
|
|
11
|
+
discounts?:QuotedRamp.Discount[];
|
|
12
|
+
|
|
13
|
+
item_tiers?:QuotedRamp.ItemTier[];
|
|
14
|
+
|
|
15
|
+
coupon_applicability_mappings?:QuotedRamp.CouponApplicabilityMapping[];
|
|
16
|
+
|
|
17
|
+
}
|
|
18
|
+
export namespace QuotedRamp {
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
export interface LineItem {
|
|
22
|
+
item_price_id:string;
|
|
23
|
+
|
|
24
|
+
item_type:'plan' | 'addon' | 'charge';
|
|
25
|
+
|
|
26
|
+
quantity?:number;
|
|
27
|
+
|
|
28
|
+
quantity_in_decimal?:string;
|
|
29
|
+
|
|
30
|
+
metered_quantity?:string;
|
|
31
|
+
|
|
32
|
+
unit_price?:number;
|
|
33
|
+
|
|
34
|
+
unit_price_in_decimal?:string;
|
|
35
|
+
|
|
36
|
+
amount?:number;
|
|
37
|
+
|
|
38
|
+
amount_in_decimal?:string;
|
|
39
|
+
|
|
40
|
+
billing_period?:number;
|
|
41
|
+
|
|
42
|
+
billing_period_unit?:'day' | 'week' | 'month' | 'year';
|
|
43
|
+
|
|
44
|
+
free_quantity?:number;
|
|
45
|
+
|
|
46
|
+
free_quantity_in_decimal?:string;
|
|
47
|
+
|
|
48
|
+
billing_cycles?:number;
|
|
49
|
+
|
|
50
|
+
service_period_days?:number;
|
|
51
|
+
|
|
52
|
+
charge_on_event?:'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination';
|
|
53
|
+
|
|
54
|
+
charge_once?:boolean;
|
|
55
|
+
|
|
56
|
+
charge_on_option?:'immediately' | 'on_event';
|
|
57
|
+
|
|
58
|
+
start_date?:number;
|
|
59
|
+
|
|
60
|
+
end_date?:number;
|
|
61
|
+
|
|
62
|
+
ramp_tier_id?:string;
|
|
63
|
+
|
|
64
|
+
discount_per_billing_cycle?:number;
|
|
65
|
+
|
|
66
|
+
discount_per_billing_cycle_in_decimal?:string;
|
|
67
|
+
|
|
68
|
+
item_level_discount_per_billing_cycle?:number;
|
|
69
|
+
|
|
70
|
+
item_level_discount_per_billing_cycle_in_decimal?:string;
|
|
71
|
+
|
|
72
|
+
amount_per_billing_cycle?:number;
|
|
73
|
+
|
|
74
|
+
amount_per_billing_cycle_in_decimal?:string;
|
|
75
|
+
|
|
76
|
+
net_amount_per_billing_cycle?:number;
|
|
77
|
+
|
|
78
|
+
net_amount_per_billing_cycle_in_decimal?:string;
|
|
79
|
+
}
|
|
80
|
+
export interface Discount {
|
|
81
|
+
id:string;
|
|
82
|
+
|
|
83
|
+
invoice_name?:string;
|
|
84
|
+
|
|
85
|
+
type:'fixed_amount' | 'percentage';
|
|
86
|
+
|
|
87
|
+
percentage?:number;
|
|
88
|
+
|
|
89
|
+
amount?:number;
|
|
90
|
+
|
|
91
|
+
duration_type:'one_time' | 'forever' | 'limited_period';
|
|
92
|
+
|
|
93
|
+
entity_type:'item_level_coupon' | 'document_level_coupon' | 'item_level_discount' | 'document_level_discount';
|
|
94
|
+
|
|
95
|
+
entity_id?:string;
|
|
96
|
+
|
|
97
|
+
period?:number;
|
|
98
|
+
|
|
99
|
+
period_unit?:'day' | 'week' | 'month' | 'year';
|
|
100
|
+
|
|
101
|
+
included_in_mrr:boolean;
|
|
102
|
+
|
|
103
|
+
apply_on:'invoice_amount' | 'specific_item_price';
|
|
104
|
+
|
|
105
|
+
item_price_id?:string;
|
|
106
|
+
|
|
107
|
+
created_at:number;
|
|
108
|
+
|
|
109
|
+
updated_at?:number;
|
|
110
|
+
|
|
111
|
+
start_date?:number;
|
|
112
|
+
|
|
113
|
+
end_date?:number;
|
|
114
|
+
}
|
|
115
|
+
export interface ItemTier {
|
|
116
|
+
item_price_id:string;
|
|
117
|
+
|
|
118
|
+
starting_unit:number;
|
|
119
|
+
|
|
120
|
+
ending_unit?:number;
|
|
121
|
+
|
|
122
|
+
price:number;
|
|
123
|
+
|
|
124
|
+
starting_unit_in_decimal?:string;
|
|
125
|
+
|
|
126
|
+
ending_unit_in_decimal?:string;
|
|
127
|
+
|
|
128
|
+
price_in_decimal?:string;
|
|
129
|
+
|
|
130
|
+
ramp_tier_id?:string;
|
|
131
|
+
|
|
132
|
+
pricing_type?:'per_unit' | 'flat_fee' | 'package';
|
|
133
|
+
|
|
134
|
+
package_size?:number;
|
|
135
|
+
}
|
|
136
|
+
export interface CouponApplicabilityMapping {
|
|
137
|
+
coupon_id?:string;
|
|
138
|
+
|
|
139
|
+
applicable_item_price_ids?:string[];
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
@@ -1,63 +1,26 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface ResourceMigration {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description Domain name to which the item is moved.
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
from_site:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Type of the entity this record is stored for \* customer - Entity that represents a customer
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
entity_type:'customer';
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description Handle of the customer in the current site.
|
|
21
10
|
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
11
|
entity_id:string;
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Status of the copy customer process. \* failed - Failed \* succeeded - Succeeded \* scheduled - Scheduled
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
status:'scheduled' | 'failed' | 'succeeded';
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description Filled only if the copy operation gets failed
|
|
35
14
|
|
|
36
|
-
*/
|
|
37
|
-
|
|
38
15
|
errors?:string;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description Time the log is created
|
|
42
16
|
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
17
|
created_at:number;
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* @description Time the log is updated
|
|
49
18
|
|
|
50
|
-
*/
|
|
51
|
-
|
|
52
19
|
updated_at:number;
|
|
20
|
+
|
|
53
21
|
}
|
|
54
22
|
export namespace ResourceMigration {
|
|
55
23
|
export class ResourceMigrationResource {
|
|
56
|
-
/**
|
|
57
|
-
* @description Gets the last migration details.
|
|
58
|
-
|
|
59
|
-
*/
|
|
60
|
-
|
|
61
24
|
retrieve_latest(input:RetrieveLatestInputParam):ChargebeeRequest<RetrieveLatestResponse>;
|
|
62
25
|
}
|
|
63
26
|
export interface RetrieveLatestResponse {
|
|
@@ -65,25 +28,10 @@ declare module 'chargebee' {
|
|
|
65
28
|
}
|
|
66
29
|
export interface RetrieveLatestInputParam {
|
|
67
30
|
|
|
68
|
-
/**
|
|
69
|
-
* @description Gets the last migration details.
|
|
70
|
-
|
|
71
|
-
*/
|
|
72
|
-
|
|
73
31
|
from_site:string;
|
|
74
32
|
|
|
75
|
-
/**
|
|
76
|
-
* @description Gets the last migration details.
|
|
77
|
-
|
|
78
|
-
*/
|
|
79
|
-
|
|
80
33
|
entity_type:'customer';
|
|
81
34
|
|
|
82
|
-
/**
|
|
83
|
-
* @description Gets the last migration details.
|
|
84
|
-
|
|
85
|
-
*/
|
|
86
|
-
|
|
87
35
|
entity_id:string;
|
|
88
36
|
}
|
|
89
37
|
|
|
@@ -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
|
|
|
@@ -738,6 +736,8 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
738
736
|
*/
|
|
739
737
|
|
|
740
738
|
offset?:string;
|
|
739
|
+
|
|
740
|
+
sort_by?:{asc?:'created_at',desc?:'created_at'};
|
|
741
741
|
}
|
|
742
742
|
export interface ListDiscountsResponse {
|
|
743
743
|
list:{discount:Discount}[];
|
|
@@ -795,7 +795,11 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
795
795
|
}
|
|
796
796
|
export interface RemoveScheduledCancellationInputParam {
|
|
797
797
|
|
|
798
|
+
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
|
|
799
|
+
|
|
798
800
|
billing_cycles?:number;
|
|
801
|
+
|
|
802
|
+
contract_term_billing_cycle_on_renewal?:number;
|
|
799
803
|
}
|
|
800
804
|
export interface RemoveCouponsResponse {
|
|
801
805
|
subscription:Subscription;
|
|
@@ -827,7 +831,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
827
831
|
|
|
828
832
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
829
833
|
|
|
830
|
-
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};
|
|
831
835
|
|
|
832
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};
|
|
833
837
|
|
|
@@ -936,7 +940,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
936
940
|
|
|
937
941
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
938
942
|
|
|
939
|
-
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};
|
|
940
944
|
|
|
941
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};
|
|
942
946
|
|
|
@@ -1068,7 +1072,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1068
1072
|
|
|
1069
1073
|
statement_descriptor?:{descriptor?:string};
|
|
1070
1074
|
|
|
1071
|
-
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};
|
|
1072
1076
|
|
|
1073
1077
|
trial_end?:number;
|
|
1074
1078
|
|
|
@@ -1596,7 +1600,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1596
1600
|
}
|
|
1597
1601
|
export interface ResumeInputParam {
|
|
1598
1602
|
|
|
1599
|
-
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};
|
|
1600
1604
|
|
|
1601
1605
|
resume_option?:ResumeOption;
|
|
1602
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
|
}
|