chargebee 2.51.0 → 2.53.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 +83 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +103 -5
- package/package.json +1 -1
- package/types/core.d.ts +6 -6
- package/types/index.d.ts +10 -0
- package/types/resources/Addon.d.ts +3 -3
- package/types/resources/Address.d.ts +2 -194
- package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
- package/types/resources/AttachedItem.d.ts +1 -1
- 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 +10 -8
- package/types/resources/BusinessEntityTransfer.d.ts +10 -7
- package/types/resources/Card.d.ts +11 -311
- package/types/resources/Comment.d.ts +10 -125
- package/types/resources/Contact.d.ts +2 -44
- package/types/resources/ContractTerm.d.ts +4 -72
- package/types/resources/Coupon.d.ts +4 -41
- package/types/resources/CouponCode.d.ts +67 -35
- package/types/resources/CouponSet.d.ts +12 -121
- package/types/resources/CreditNote.d.ts +89 -95
- package/types/resources/Currency.d.ts +8 -5
- package/types/resources/Customer.d.ts +96 -95
- package/types/resources/CustomerEntitlement.d.ts +3 -1
- package/types/resources/DifferentialPrice.d.ts +1 -1
- package/types/resources/Discount.d.ts +5 -90
- 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 -14
- package/types/resources/Event.d.ts +24 -109
- package/types/resources/Export.d.ts +116 -432
- package/types/resources/Feature.d.ts +19 -321
- 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/HostedPage.d.ts +4 -4
- package/types/resources/ImpactedCustomer.d.ts +23 -0
- 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 +112 -126
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +4 -11
- package/types/resources/ItemEntitlement.d.ts +15 -155
- package/types/resources/ItemFamily.d.ts +3 -3
- package/types/resources/ItemPrice.d.ts +7 -7
- package/types/resources/NonSubscription.d.ts +9 -6
- package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
- package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
- package/types/resources/OmnichannelSubscription.d.ts +2 -2
- package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
- package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
- package/types/resources/Order.d.ts +3 -3
- package/types/resources/PaymentIntent.d.ts +9 -255
- package/types/resources/PaymentReferenceNumber.d.ts +3 -20
- package/types/resources/PaymentSource.d.ts +4 -4
- package/types/resources/PaymentVoucher.d.ts +22 -205
- package/types/resources/Plan.d.ts +3 -3
- package/types/resources/PortalSession.d.ts +4 -146
- package/types/resources/PriceVariant.d.ts +2 -2
- package/types/resources/PricingPageSession.d.ts +2 -2
- package/types/resources/PromotionalCredit.d.ts +12 -215
- package/types/resources/Purchase.d.ts +5 -3
- package/types/resources/Quote.d.ts +32 -14
- package/types/resources/QuotedCharge.d.ts +7 -0
- package/types/resources/QuotedRamp.d.ts +11 -16
- package/types/resources/Ramp.d.ts +7 -7
- package/types/resources/RecordedPurchase.d.ts +8 -1
- package/types/resources/ResourceMigration.d.ts +2 -54
- package/types/resources/SiteMigrationDetail.d.ts +13 -55
- package/types/resources/Subscription.d.ts +33 -29
- package/types/resources/SubscriptionEntitlement.d.ts +6 -106
- package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
- 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 +8 -8
- package/types/resources/UnbilledCharge.d.ts +1 -1
- package/types/resources/Usage.d.ts +21 -165
- package/types/resources/UsageFile.d.ts +5 -5
- package/types/resources/VirtualBankAccount.d.ts +1 -1
- package/types/resources/WebhookEndpoint.d.ts +117 -0
|
@@ -83,15 +83,15 @@ declare module 'chargebee' {
|
|
|
83
83
|
}
|
|
84
84
|
export interface UpdateInputParam {
|
|
85
85
|
|
|
86
|
-
items_to_add:{billing_cycles?:
|
|
86
|
+
items_to_add:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
|
|
87
87
|
|
|
88
|
-
items_to_update:{billing_cycles?:
|
|
88
|
+
items_to_update:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
|
|
89
89
|
|
|
90
|
-
item_tiers?:{ending_unit?:
|
|
90
|
+
item_tiers?:{ending_unit?:any,ending_unit_in_decimal?:any,item_price_id?:any,package_size?:any,price?:any,price_in_decimal?:any,pricing_type?:any,starting_unit?:any,starting_unit_in_decimal?:any}[];
|
|
91
91
|
|
|
92
|
-
coupons_to_add?:{apply_till?:
|
|
92
|
+
coupons_to_add?:{apply_till?:any,coupon_id?:any}[];
|
|
93
93
|
|
|
94
|
-
discounts_to_add:{amount?:
|
|
94
|
+
discounts_to_add:{amount?:any,apply_on:any,duration_type:any,included_in_mrr?:any,item_price_id?:any,percentage?:any,period?:any,period_unit?:any}[];
|
|
95
95
|
|
|
96
96
|
effective_from:number;
|
|
97
97
|
|
|
@@ -126,7 +126,7 @@ declare module 'chargebee' {
|
|
|
126
126
|
limit?:number;
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
129
|
+
* @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.
|
|
130
130
|
|
|
131
131
|
*/
|
|
132
132
|
|
|
@@ -167,7 +167,7 @@ declare module 'chargebee' {
|
|
|
167
167
|
|
|
168
168
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
169
169
|
|
|
170
|
-
sort_by?:
|
|
170
|
+
sort_by?:object;
|
|
171
171
|
}
|
|
172
172
|
export interface ItemsToAdd {
|
|
173
173
|
item_price_id:string;
|
|
@@ -22,6 +22,8 @@ declare module 'chargebee' {
|
|
|
22
22
|
|
|
23
23
|
linked_omnichannel_subscriptions?:RecordedPurchase.LinkedOmnichannelSubscription[];
|
|
24
24
|
|
|
25
|
+
linked_omnichannel_one_time_orders?:RecordedPurchase.LinkedOmnichannelOneTimeOrder[];
|
|
26
|
+
|
|
25
27
|
error_detail?:RecordedPurchase.ErrorDetail;
|
|
26
28
|
|
|
27
29
|
}
|
|
@@ -42,7 +44,9 @@ declare module 'chargebee' {
|
|
|
42
44
|
|
|
43
45
|
apple_app_store?:{product_id?:string,receipt?:string,transaction_id?:string};
|
|
44
46
|
|
|
45
|
-
google_play_store?:{purchase_token?:string};
|
|
47
|
+
google_play_store?:{order_id?:string,product_id?:string,purchase_token?:string};
|
|
48
|
+
|
|
49
|
+
omnichannel_subscription?:{id?:string};
|
|
46
50
|
|
|
47
51
|
app_id:string;
|
|
48
52
|
}
|
|
@@ -53,6 +57,9 @@ declare module 'chargebee' {
|
|
|
53
57
|
export interface LinkedOmnichannelSubscription {
|
|
54
58
|
omnichannel_subscription_id?:string;
|
|
55
59
|
}
|
|
60
|
+
export interface LinkedOmnichannelOneTimeOrder {
|
|
61
|
+
omnichannel_one_time_order_id?:string;
|
|
62
|
+
}
|
|
56
63
|
export interface ErrorDetail {
|
|
57
64
|
error_message?:string;
|
|
58
65
|
}
|
|
@@ -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
|
}
|
|
@@ -253,7 +253,7 @@ declare module 'chargebee' {
|
|
|
253
253
|
unbilled_charges?:UnbilledCharge[];
|
|
254
254
|
}
|
|
255
255
|
export interface CreateInputParam {
|
|
256
|
-
|
|
256
|
+
|
|
257
257
|
customer?:object;
|
|
258
258
|
|
|
259
259
|
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,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
@@ -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
|
|
|
@@ -356,12 +356,12 @@ declare module 'chargebee' {
|
|
|
356
356
|
unbilled_charges?:UnbilledCharge[];
|
|
357
357
|
}
|
|
358
358
|
export interface CreateForCustomerInputParam {
|
|
359
|
-
|
|
359
|
+
|
|
360
360
|
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};
|
|
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
|
|
|
@@ -443,12 +443,12 @@ declare module 'chargebee' {
|
|
|
443
443
|
unbilled_charges?:UnbilledCharge[];
|
|
444
444
|
}
|
|
445
445
|
export interface CreateWithItemsInputParam {
|
|
446
|
-
|
|
446
|
+
|
|
447
447
|
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};
|
|
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
|
|
|
@@ -456,7 +456,7 @@ declare module 'chargebee' {
|
|
|
456
456
|
|
|
457
457
|
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,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
|
|
458
458
|
|
|
459
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
459
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
460
460
|
|
|
461
461
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
462
462
|
|
|
@@ -535,7 +535,7 @@ declare module 'chargebee' {
|
|
|
535
535
|
limit?:number;
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
538
|
+
* @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.
|
|
539
539
|
|
|
540
540
|
*/
|
|
541
541
|
|
|
@@ -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
|
|
|
@@ -622,7 +620,7 @@ declare module 'chargebee' {
|
|
|
622
620
|
created_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
623
621
|
|
|
624
622
|
/**
|
|
625
|
-
* @description Time at which the subscription
|
|
623
|
+
* @description Time at which the subscription?`status`?last changed to? `active`. For example, this value is updated when an?`in_trial`?or? `cancelled`?subscription activates.
|
|
626
624
|
|
|
627
625
|
*/
|
|
628
626
|
|
|
@@ -677,7 +675,7 @@ declare module 'chargebee' {
|
|
|
677
675
|
|
|
678
676
|
override_relationship?:{is?:'true' | 'false'};
|
|
679
677
|
|
|
680
|
-
sort_by?:
|
|
678
|
+
sort_by?:object;
|
|
681
679
|
|
|
682
680
|
/**
|
|
683
681
|
* @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.
|
|
@@ -712,7 +710,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
712
710
|
limit?:number;
|
|
713
711
|
|
|
714
712
|
/**
|
|
715
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
713
|
+
* @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.
|
|
716
714
|
|
|
717
715
|
*/
|
|
718
716
|
|
|
@@ -733,13 +731,13 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
733
731
|
limit?:number;
|
|
734
732
|
|
|
735
733
|
/**
|
|
736
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
734
|
+
* @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.
|
|
737
735
|
|
|
738
736
|
*/
|
|
739
737
|
|
|
740
738
|
offset?:string;
|
|
741
739
|
|
|
742
|
-
sort_by?:
|
|
740
|
+
sort_by?:object;
|
|
743
741
|
}
|
|
744
742
|
export interface ListDiscountsResponse {
|
|
745
743
|
list:{discount:Discount}[];
|
|
@@ -756,7 +754,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
756
754
|
limit?:number;
|
|
757
755
|
|
|
758
756
|
/**
|
|
759
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
757
|
+
* @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.
|
|
760
758
|
|
|
761
759
|
*/
|
|
762
760
|
|
|
@@ -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;
|
|
@@ -824,12 +826,12 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
824
826
|
credit_notes?:CreditNote[];
|
|
825
827
|
}
|
|
826
828
|
export interface UpdateInputParam {
|
|
827
|
-
|
|
829
|
+
|
|
828
830
|
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,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
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
|
|
|
@@ -933,12 +935,12 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
933
935
|
credit_notes?:CreditNote[];
|
|
934
936
|
}
|
|
935
937
|
export interface UpdateForItemsInputParam {
|
|
936
|
-
|
|
938
|
+
|
|
937
939
|
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,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
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
|
|
|
@@ -954,7 +956,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
954
956
|
|
|
955
957
|
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,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
|
|
956
958
|
|
|
957
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
959
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
958
960
|
|
|
959
961
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
960
962
|
|
|
@@ -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
|
|
|
@@ -1206,7 +1208,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1206
1208
|
invoice?:Invoice;
|
|
1207
1209
|
}
|
|
1208
1210
|
export interface ImportSubscriptionInputParam {
|
|
1209
|
-
|
|
1211
|
+
|
|
1210
1212
|
customer?:object;
|
|
1211
1213
|
|
|
1212
1214
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
@@ -1295,7 +1297,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1295
1297
|
invoice?:Invoice;
|
|
1296
1298
|
}
|
|
1297
1299
|
export interface ImportForCustomerInputParam {
|
|
1298
|
-
|
|
1300
|
+
|
|
1299
1301
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
1300
1302
|
|
|
1301
1303
|
transaction?:{amount?:number,date?:number,payment_method?:PaymentMethod,reference_number?:string};
|
|
@@ -1378,7 +1380,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1378
1380
|
}
|
|
1379
1381
|
export interface ImportUnbilledChargesInputParam {
|
|
1380
1382
|
|
|
1381
|
-
unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
|
|
1383
|
+
unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
|
|
1382
1384
|
|
|
1383
1385
|
discounts:{amount:number,description?:string,entity_id?:string,entity_type?:'item_level_coupon' | 'document_level_coupon' | 'item_level_discount' | 'document_level_discount',unbilled_charge_id?:string}[];
|
|
1384
1386
|
|
|
@@ -1394,7 +1396,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1394
1396
|
invoice?:Invoice;
|
|
1395
1397
|
}
|
|
1396
1398
|
export interface ImportForItemsInputParam {
|
|
1397
|
-
|
|
1399
|
+
|
|
1398
1400
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
1399
1401
|
|
|
1400
1402
|
transaction?:{amount?:number,date?:number,payment_method?:PaymentMethod,reference_number?:string};
|
|
@@ -1403,7 +1405,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1403
1405
|
|
|
1404
1406
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,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}[];
|
|
1405
1407
|
|
|
1406
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
1408
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
1407
1409
|
|
|
1408
1410
|
charged_items?:{item_price_id?:string,last_charged_at?:number}[];
|
|
1409
1411
|
|
|
@@ -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
|
|
|
@@ -1859,12 +1861,14 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1859
1861
|
|
|
1860
1862
|
invoice_name?:string;
|
|
1861
1863
|
|
|
1862
|
-
type:'fixed_amount' | 'percentage';
|
|
1864
|
+
type:'fixed_amount' | 'percentage' | 'offer_quantity';
|
|
1863
1865
|
|
|
1864
1866
|
percentage?:number;
|
|
1865
1867
|
|
|
1866
1868
|
amount?:number;
|
|
1867
1869
|
|
|
1870
|
+
quantity?:number;
|
|
1871
|
+
|
|
1868
1872
|
currency_code?:string;
|
|
1869
1873
|
|
|
1870
1874
|
duration_type:'one_time' | 'forever' | 'limited_period';
|