chargebee 2.31.0 → 2.33.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 +34 -13
- package/LICENSE +1 -1
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +20 -15
- package/package.json +1 -1
- package/types/core.d.ts +2 -2
- package/types/index.d.ts +1 -0
- package/types/resources/CreditNote.d.ts +9 -9
- package/types/resources/CreditNoteEstimate.d.ts +27 -19
- package/types/resources/Entitlement.d.ts +102 -5
- package/types/resources/Estimate.d.ts +25 -15
- package/types/resources/Event.d.ts +3 -1
- package/types/resources/GatewayErrorDetail.d.ts +76 -0
- package/types/resources/HostedPage.d.ts +7 -0
- package/types/resources/ImpactedSubscription.d.ts +7 -7
- package/types/resources/Invoice.d.ts +2 -2
- package/types/resources/InvoiceEstimate.d.ts +3 -1
- package/types/resources/ItemEntitlement.d.ts +50 -12
- package/types/resources/ItemPrice.d.ts +21 -3
- package/types/resources/Order.d.ts +85 -4
- package/types/resources/PaymentIntent.d.ts +13 -5
- package/types/resources/PaymentVoucher.d.ts +3 -3
- package/types/resources/PortalSession.d.ts +5 -5
- package/types/resources/Purchase.d.ts +7 -7
- package/types/resources/Quote.d.ts +1 -1
- package/types/resources/QuoteLineGroup.d.ts +1 -1
- package/types/resources/QuotedCharge.d.ts +12 -12
- package/types/resources/QuotedSubscription.d.ts +27 -20
- package/types/resources/Subscription.d.ts +7 -0
- package/types/resources/Transaction.d.ts +80 -2
- package/types/resources/Usage.d.ts +2 -2
|
@@ -1381,28 +1381,109 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
1381
1381
|
validation_status?:ValidationStatus;
|
|
1382
1382
|
}
|
|
1383
1383
|
export interface LineItemTax {
|
|
1384
|
+
/**
|
|
1385
|
+
* @description The unique reference id of the line item for which the tax is applicable
|
|
1386
|
+
|
|
1387
|
+
*/
|
|
1388
|
+
|
|
1384
1389
|
line_item_id?:string;
|
|
1385
1390
|
|
|
1386
|
-
|
|
1391
|
+
/**
|
|
1392
|
+
* @description The name of the tax applied
|
|
1393
|
+
|
|
1394
|
+
*/
|
|
1395
|
+
|
|
1396
|
+
tax_name:string;
|
|
1397
|
+
|
|
1398
|
+
/**
|
|
1399
|
+
* @description The rate of tax used to calculate tax amount
|
|
1400
|
+
|
|
1401
|
+
*/
|
|
1402
|
+
|
|
1403
|
+
tax_rate:number;
|
|
1404
|
+
|
|
1405
|
+
/**
|
|
1406
|
+
* @description Indicates the service period end of the tax rate for the line item.
|
|
1407
|
+
|
|
1408
|
+
*/
|
|
1409
|
+
|
|
1410
|
+
date_to?:number;
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* @description Indicates the service period start of the tax rate for the line item.
|
|
1414
|
+
|
|
1415
|
+
*/
|
|
1416
|
+
|
|
1417
|
+
date_from?:number;
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* @description Indicates the prorated line item amount in cents.
|
|
1421
|
+
|
|
1422
|
+
*/
|
|
1423
|
+
|
|
1424
|
+
prorated_taxable_amount?:number;
|
|
1387
1425
|
|
|
1388
|
-
|
|
1426
|
+
/**
|
|
1427
|
+
* @description Indicates if tax is applied only on a portion of the line item amount.
|
|
1428
|
+
|
|
1429
|
+
*/
|
|
1389
1430
|
|
|
1390
1431
|
is_partial_tax_applied?:boolean;
|
|
1391
1432
|
|
|
1433
|
+
/**
|
|
1434
|
+
* @description Indicates the non-compliance tax that should not be reported to the jurisdiction.
|
|
1435
|
+
|
|
1436
|
+
*/
|
|
1437
|
+
|
|
1392
1438
|
is_non_compliance_tax?:boolean;
|
|
1393
1439
|
|
|
1394
|
-
|
|
1440
|
+
/**
|
|
1441
|
+
* @description Indicates the actual portion of the line item amount that is taxable.
|
|
1442
|
+
|
|
1443
|
+
*/
|
|
1444
|
+
|
|
1445
|
+
taxable_amount:number;
|
|
1395
1446
|
|
|
1396
|
-
|
|
1447
|
+
/**
|
|
1448
|
+
* @description The tax amount
|
|
1449
|
+
|
|
1450
|
+
*/
|
|
1451
|
+
|
|
1452
|
+
tax_amount:number;
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* @description The type of tax jurisdiction \* federal - The tax jurisdiction is a federal \* state - The tax jurisdiction is a state \* county - The tax jurisdiction is a county \* country - The tax jurisdiction is a country \* city - The tax jurisdiction is a city \* special - Special tax jurisdiction. \* unincorporated - Combined tax of state and county. \* other - Jurisdictions other than the ones listed above.
|
|
1456
|
+
|
|
1457
|
+
*/
|
|
1397
1458
|
|
|
1398
1459
|
tax_juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state';
|
|
1399
1460
|
|
|
1461
|
+
/**
|
|
1462
|
+
* @description The name of the tax jurisdiction
|
|
1463
|
+
|
|
1464
|
+
*/
|
|
1465
|
+
|
|
1400
1466
|
tax_juris_name?:string;
|
|
1401
1467
|
|
|
1468
|
+
/**
|
|
1469
|
+
* @description The tax jurisdiction code
|
|
1470
|
+
|
|
1471
|
+
*/
|
|
1472
|
+
|
|
1402
1473
|
tax_juris_code?:string;
|
|
1403
1474
|
|
|
1475
|
+
/**
|
|
1476
|
+
* @description Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
|
|
1477
|
+
|
|
1478
|
+
*/
|
|
1479
|
+
|
|
1404
1480
|
tax_amount_in_local_currency?:number;
|
|
1405
1481
|
|
|
1482
|
+
/**
|
|
1483
|
+
* @description The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
|
|
1484
|
+
|
|
1485
|
+
*/
|
|
1486
|
+
|
|
1406
1487
|
local_currency_code?:string;
|
|
1407
1488
|
}
|
|
1408
1489
|
export interface LineItemDiscount {
|
|
@@ -52,7 +52,7 @@ declare module 'chargebee' {
|
|
|
52
52
|
reference_id?:string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* @description The payment method of this intent \* google_pay - google_pay \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* dotpay - dotpay \* giropay - giropay \* sofort - sofort \* direct_debit - direct_debit \* paypal_express_checkout - paypal_express_checkout \* boleto - boleto \* card - card \* upi - upi
|
|
55
|
+
* @description The payment method of this intent \* google_pay - google_pay \* apple_pay - apple_pay \* ideal - ideal \* bancontact - bancontact \* netbanking_emandates - netbanking_emandates \* pay_to - PayTo \* venmo - Venmo \* dotpay - dotpay \* giropay - giropay \* sofort - sofort \* sepa_instant_transfer - SEPA Instant Transfer \* direct_debit - direct_debit \* paypal_express_checkout - paypal_express_checkout \* boleto - boleto \* faster_payments - Faster Payments \* amazon_payments - amazon_payments \* card - card \* upi - upi
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -306,10 +306,10 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
306
306
|
|
|
307
307
|
*/
|
|
308
308
|
|
|
309
|
-
status
|
|
309
|
+
status:'pending_authorization' | 'inited' | 'refused' | 'requires_challenge' | 'authorized' | 'requires_identification' | 'requires_redirection';
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* @description The payment method of this attempt \* ideal - ideal \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout \* giropay - giropay \* bancontact - bancontact \* google_pay - google_pay \* card - card \* upi - upi \* direct_debit - direct_debit \* dotpay - dotpay \* apple_pay - apple_pay \* boleto - boleto \* netbanking_emandates - netbanking_emandates
|
|
312
|
+
* @description The payment method of this attempt \* venmo - Venmo \* ideal - ideal \* sofort - sofort \* paypal_express_checkout - paypal_express_checkout \* giropay - giropay \* sepa_instant_transfer - SEPA Instant Transfer \* bancontact - bancontact \* google_pay - google_pay \* card - card \* faster_payments - faster payments \* upi - upi \* amazon_payments - amazon_payments \* direct_debit - direct_debit \* dotpay - dotpay \* apple_pay - apple_pay \* boleto - boleto \* pay_to - PayTo \* netbanking_emandates - netbanking_emandates
|
|
313
313
|
|
|
314
314
|
*/
|
|
315
315
|
|
|
@@ -341,14 +341,22 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
|
|
|
341
341
|
|
|
342
342
|
*/
|
|
343
343
|
|
|
344
|
-
created_at
|
|
344
|
+
created_at:number;
|
|
345
345
|
|
|
346
346
|
/**
|
|
347
347
|
* @description Timestamp indicating when the active payment attempt was last modified.
|
|
348
348
|
|
|
349
349
|
*/
|
|
350
350
|
|
|
351
|
-
modified_at
|
|
351
|
+
modified_at:number;
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* @description Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about [gateway error references](gateway_error_references)
|
|
355
|
+
This attribute will be available soon
|
|
356
|
+
|
|
357
|
+
*/
|
|
358
|
+
|
|
359
|
+
error_detail?:GatewayErrorDetail;
|
|
352
360
|
}
|
|
353
361
|
}
|
|
354
362
|
}
|
|
@@ -74,7 +74,7 @@ declare module 'chargebee' {
|
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* @description The gateway through which this payment voucher was created.
|
|
77
|
-
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* 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.
|
|
77
|
+
**Note** : Note: Currently, `stripe` is the only supported gateway through which you can create the payment voucher. \* 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.
|
|
78
78
|
|
|
79
79
|
*/
|
|
80
80
|
|
|
@@ -197,14 +197,14 @@ declare module 'chargebee' {
|
|
|
197
197
|
|
|
198
198
|
*/
|
|
199
199
|
|
|
200
|
-
voucher_payment_source
|
|
200
|
+
voucher_payment_source:{voucher_type:VoucherType};
|
|
201
201
|
|
|
202
202
|
/**
|
|
203
203
|
* @description Parameters for `invoice_allocations`
|
|
204
204
|
|
|
205
205
|
*/
|
|
206
206
|
|
|
207
|
-
invoice_allocations
|
|
207
|
+
invoice_allocations:{invoice_id:string}[];
|
|
208
208
|
}
|
|
209
209
|
export interface RetrieveResponse {
|
|
210
210
|
payment_voucher:PaymentVoucher;
|
|
@@ -100,7 +100,7 @@ declare module 'chargebee' {
|
|
|
100
100
|
|
|
101
101
|
*/
|
|
102
102
|
|
|
103
|
-
create(input
|
|
103
|
+
create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
106
|
* @description This API retrieves a portal session using `portal_session_id` as a path parameter.
|
|
@@ -162,7 +162,7 @@ If this API is called for a Portal Session that currently is in :
|
|
|
162
162
|
|
|
163
163
|
*/
|
|
164
164
|
|
|
165
|
-
customer
|
|
165
|
+
customer:{id:string};
|
|
166
166
|
}
|
|
167
167
|
export interface RetrieveResponse {
|
|
168
168
|
portal_session:PortalSession;
|
|
@@ -204,21 +204,21 @@ If this API is called for a Portal Session that currently is in :
|
|
|
204
204
|
|
|
205
205
|
*/
|
|
206
206
|
|
|
207
|
-
has_billing_address
|
|
207
|
+
has_billing_address:boolean;
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
210
|
* @description The customer has payment method.
|
|
211
211
|
|
|
212
212
|
*/
|
|
213
213
|
|
|
214
|
-
has_payment_method
|
|
214
|
+
has_payment_method:boolean;
|
|
215
215
|
|
|
216
216
|
/**
|
|
217
217
|
* @description The customer has atleast one active subscription.
|
|
218
218
|
|
|
219
219
|
*/
|
|
220
220
|
|
|
221
|
-
has_active_subscription
|
|
221
|
+
has_active_subscription:boolean;
|
|
222
222
|
}
|
|
223
223
|
}
|
|
224
224
|
}
|
|
@@ -116,7 +116,7 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
116
116
|
|
|
117
117
|
*/
|
|
118
118
|
|
|
119
|
-
estimate(input
|
|
119
|
+
estimate(input:EstimateInputParam):ChargebeeRequest<EstimateResponse>;
|
|
120
120
|
}
|
|
121
121
|
export interface CreateResponse {
|
|
122
122
|
purchase:Purchase;
|
|
@@ -142,14 +142,14 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
142
142
|
|
|
143
143
|
*/
|
|
144
144
|
|
|
145
|
-
purchase_items
|
|
145
|
+
purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
146
146
|
|
|
147
147
|
/**
|
|
148
148
|
* @description Parameters for item_tiers
|
|
149
149
|
|
|
150
150
|
*/
|
|
151
151
|
|
|
152
|
-
item_tiers
|
|
152
|
+
item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
155
|
* @description Parameters for shipping_addresses
|
|
@@ -170,7 +170,7 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
170
170
|
|
|
171
171
|
*/
|
|
172
172
|
|
|
173
|
-
subscription_info
|
|
173
|
+
subscription_info:{billing_cycles?:number,index:number,meta_data?:object,subscription_id?:string}[];
|
|
174
174
|
}
|
|
175
175
|
export interface EstimateResponse {
|
|
176
176
|
estimate:Estimate;
|
|
@@ -210,14 +210,14 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
210
210
|
|
|
211
211
|
*/
|
|
212
212
|
|
|
213
|
-
purchase_items
|
|
213
|
+
purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
216
|
* @description Parameters for item_tiers
|
|
217
217
|
|
|
218
218
|
*/
|
|
219
219
|
|
|
220
|
-
item_tiers
|
|
220
|
+
item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
221
221
|
|
|
222
222
|
/**
|
|
223
223
|
* @description Parameters for shipping_addresses
|
|
@@ -238,7 +238,7 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
|
|
|
238
238
|
|
|
239
239
|
*/
|
|
240
240
|
|
|
241
|
-
subscription_info
|
|
241
|
+
subscription_info:{billing_cycles?:number,index:number,subscription_id?:string}[];
|
|
242
242
|
}
|
|
243
243
|
|
|
244
244
|
}
|
|
@@ -1543,7 +1543,7 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1543
1543
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
|
|
1546
|
-
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
1546
|
+
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
1547
1547
|
|
|
1548
1548
|
/**
|
|
1549
1549
|
* @description The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
|
|
@@ -249,7 +249,7 @@ declare module 'chargebee' {
|
|
|
249
249
|
|
|
250
250
|
*/
|
|
251
251
|
|
|
252
|
-
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
252
|
+
tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
|
|
253
253
|
|
|
254
254
|
/**
|
|
255
255
|
* @description The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
|
|
@@ -96,7 +96,7 @@ declare module 'chargebee' {
|
|
|
96
96
|
|
|
97
97
|
*/
|
|
98
98
|
|
|
99
|
-
item_price_id
|
|
99
|
+
item_price_id:string;
|
|
100
100
|
|
|
101
101
|
/**
|
|
102
102
|
* @description Item price quantity
|
|
@@ -139,14 +139,14 @@ declare module 'chargebee' {
|
|
|
139
139
|
|
|
140
140
|
*/
|
|
141
141
|
|
|
142
|
-
item_price_id
|
|
142
|
+
item_price_id:string;
|
|
143
143
|
|
|
144
144
|
/**
|
|
145
145
|
* @description The lowest value in the quantity tier.
|
|
146
146
|
|
|
147
147
|
*/
|
|
148
148
|
|
|
149
|
-
starting_unit
|
|
149
|
+
starting_unit:number;
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
152
|
* @description The highest value in the quantity tier.
|
|
@@ -160,7 +160,7 @@ declare module 'chargebee' {
|
|
|
160
160
|
|
|
161
161
|
*/
|
|
162
162
|
|
|
163
|
-
price
|
|
163
|
+
price:number;
|
|
164
164
|
|
|
165
165
|
/**
|
|
166
166
|
* @description The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
|
|
@@ -188,7 +188,7 @@ declare module 'chargebee' {
|
|
|
188
188
|
|
|
189
189
|
*/
|
|
190
190
|
|
|
191
|
-
index
|
|
191
|
+
index:number;
|
|
192
192
|
}
|
|
193
193
|
export interface Coupon {
|
|
194
194
|
/**
|
|
@@ -196,7 +196,7 @@ declare module 'chargebee' {
|
|
|
196
196
|
|
|
197
197
|
*/
|
|
198
198
|
|
|
199
|
-
coupon_id
|
|
199
|
+
coupon_id:string;
|
|
200
200
|
}
|
|
201
201
|
export interface Discount {
|
|
202
202
|
/**
|
|
@@ -204,7 +204,7 @@ declare module 'chargebee' {
|
|
|
204
204
|
|
|
205
205
|
*/
|
|
206
206
|
|
|
207
|
-
id
|
|
207
|
+
id:string;
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
210
|
* @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver=2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver=2). This is auto-generated based on the `type`, `amount`, and `currency_code` of the discount. For example, it can be `10% off` or `10$ off`.
|
|
@@ -218,7 +218,7 @@ declare module 'chargebee' {
|
|
|
218
218
|
|
|
219
219
|
*/
|
|
220
220
|
|
|
221
|
-
type
|
|
221
|
+
type:'fixed_amount' | 'percentage';
|
|
222
222
|
|
|
223
223
|
/**
|
|
224
224
|
* @description The percentage of the original amount that should be deducted from it. Only applicable when `discount.type` is percentage.
|
|
@@ -246,7 +246,7 @@ declare module 'chargebee' {
|
|
|
246
246
|
|
|
247
247
|
*/
|
|
248
248
|
|
|
249
|
-
apply_on
|
|
249
|
+
apply_on:'specific_item_price' | 'invoice_amount';
|
|
250
250
|
|
|
251
251
|
/**
|
|
252
252
|
* @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
|
|
@@ -260,7 +260,7 @@ declare module 'chargebee' {
|
|
|
260
260
|
|
|
261
261
|
*/
|
|
262
262
|
|
|
263
|
-
created_at
|
|
263
|
+
created_at:number;
|
|
264
264
|
|
|
265
265
|
/**
|
|
266
266
|
* @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
|
|
@@ -272,14 +272,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
|
|
|
272
272
|
|
|
273
273
|
*/
|
|
274
274
|
|
|
275
|
-
coupon_id
|
|
275
|
+
coupon_id:string;
|
|
276
276
|
|
|
277
277
|
/**
|
|
278
278
|
* @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
|
|
279
279
|
|
|
280
280
|
*/
|
|
281
281
|
|
|
282
|
-
index
|
|
282
|
+
index:number;
|
|
283
283
|
}
|
|
284
284
|
}
|
|
285
285
|
}
|
|
@@ -133,7 +133,7 @@ declare module 'chargebee' {
|
|
|
133
133
|
|
|
134
134
|
*/
|
|
135
135
|
|
|
136
|
-
coupon_id
|
|
136
|
+
coupon_id:string;
|
|
137
137
|
}
|
|
138
138
|
export interface Discount {
|
|
139
139
|
/**
|
|
@@ -141,7 +141,7 @@ declare module 'chargebee' {
|
|
|
141
141
|
|
|
142
142
|
*/
|
|
143
143
|
|
|
144
|
-
id
|
|
144
|
+
id:string;
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
147
|
* @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver=2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver=2). This is auto-generated based on the `type`, `amount`, and `currency_code` of the discount. For example, it can be `10% off` or `10$ off`.
|
|
@@ -155,7 +155,7 @@ declare module 'chargebee' {
|
|
|
155
155
|
|
|
156
156
|
*/
|
|
157
157
|
|
|
158
|
-
type
|
|
158
|
+
type:'fixed_amount' | 'percentage';
|
|
159
159
|
|
|
160
160
|
/**
|
|
161
161
|
* @description The percentage of the original amount that should be deducted from it. Only applicable when `discount.type` is percentage.
|
|
@@ -183,7 +183,7 @@ declare module 'chargebee' {
|
|
|
183
183
|
|
|
184
184
|
*/
|
|
185
185
|
|
|
186
|
-
duration_type
|
|
186
|
+
duration_type:'limited_period' | 'one_time' | 'forever';
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
189
|
* @description The duration of time for which the discount is attached to the subscription, in `period_units`. Applicable only when `duration_type` is `limited_period`.
|
|
@@ -204,14 +204,14 @@ declare module 'chargebee' {
|
|
|
204
204
|
|
|
205
205
|
*/
|
|
206
206
|
|
|
207
|
-
included_in_mrr
|
|
207
|
+
included_in_mrr:boolean;
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
210
|
* @description The amount on the invoice to which the discount is applied. \* invoice_amount - The discount is applied to the invoice `sub_total`. \* specific_item_price - The discount is applied to the `invoice.line_item.amount` that corresponds to the item price specified by `item_price_id`.
|
|
211
211
|
|
|
212
212
|
*/
|
|
213
213
|
|
|
214
|
-
apply_on
|
|
214
|
+
apply_on:'specific_item_price' | 'invoice_amount';
|
|
215
215
|
|
|
216
216
|
/**
|
|
217
217
|
* @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
|
|
@@ -225,7 +225,7 @@ declare module 'chargebee' {
|
|
|
225
225
|
|
|
226
226
|
*/
|
|
227
227
|
|
|
228
|
-
created_at
|
|
228
|
+
created_at:number;
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
231
|
* @description Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for `limited_period` duration type discount.
|
|
@@ -251,14 +251,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
|
|
|
251
251
|
|
|
252
252
|
*/
|
|
253
253
|
|
|
254
|
-
coupon_id
|
|
254
|
+
coupon_id:string;
|
|
255
255
|
|
|
256
256
|
/**
|
|
257
257
|
* @description The index number of the subscription to which the item price is added. Provide a unique number between `0` and `4` (inclusive) for each subscription that is to be created.
|
|
258
258
|
|
|
259
259
|
*/
|
|
260
260
|
|
|
261
|
-
index
|
|
261
|
+
index:number;
|
|
262
262
|
}
|
|
263
263
|
export interface SubscriptionItem {
|
|
264
264
|
/**
|
|
@@ -266,14 +266,14 @@ Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the pa
|
|
|
266
266
|
|
|
267
267
|
*/
|
|
268
268
|
|
|
269
|
-
item_price_id
|
|
269
|
+
item_price_id:string;
|
|
270
270
|
|
|
271
271
|
/**
|
|
272
272
|
* @description The type of item. There must be one and only one item of type `plan` in this list. \* plan - Plan \* addon - Addon \* charge - Charge
|
|
273
273
|
|
|
274
274
|
*/
|
|
275
275
|
|
|
276
|
-
item_type
|
|
276
|
+
item_type:'charge' | 'addon' | 'plan';
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
279
|
* @description The quantity of the item purchased
|
|
@@ -376,6 +376,13 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
376
376
|
*/
|
|
377
377
|
|
|
378
378
|
charge_on_option?:'on_event' | 'immediately';
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* @description null
|
|
382
|
+
|
|
383
|
+
*/
|
|
384
|
+
|
|
385
|
+
proration_type?:'partial_term' | 'full_term' | 'none';
|
|
379
386
|
}
|
|
380
387
|
export interface ItemTier {
|
|
381
388
|
/**
|
|
@@ -383,14 +390,14 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
383
390
|
|
|
384
391
|
*/
|
|
385
392
|
|
|
386
|
-
item_price_id
|
|
393
|
+
item_price_id:string;
|
|
387
394
|
|
|
388
395
|
/**
|
|
389
396
|
* @description The lowest value in the quantity tier.
|
|
390
397
|
|
|
391
398
|
*/
|
|
392
399
|
|
|
393
|
-
starting_unit
|
|
400
|
+
starting_unit:number;
|
|
394
401
|
|
|
395
402
|
/**
|
|
396
403
|
* @description The highest value in the quantity tier.
|
|
@@ -404,7 +411,7 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
404
411
|
|
|
405
412
|
*/
|
|
406
413
|
|
|
407
|
-
price
|
|
414
|
+
price:number;
|
|
408
415
|
|
|
409
416
|
/**
|
|
410
417
|
* @description The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
|
|
@@ -432,7 +439,7 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
432
439
|
|
|
433
440
|
*/
|
|
434
441
|
|
|
435
|
-
index
|
|
442
|
+
index:number;
|
|
436
443
|
}
|
|
437
444
|
export interface QuotedContractTerm {
|
|
438
445
|
/**
|
|
@@ -440,21 +447,21 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
440
447
|
|
|
441
448
|
*/
|
|
442
449
|
|
|
443
|
-
contract_start
|
|
450
|
+
contract_start:number;
|
|
444
451
|
|
|
445
452
|
/**
|
|
446
453
|
* @description The end date of the contract term
|
|
447
454
|
|
|
448
455
|
*/
|
|
449
456
|
|
|
450
|
-
contract_end
|
|
457
|
+
contract_end:number;
|
|
451
458
|
|
|
452
459
|
/**
|
|
453
460
|
* @description The number of billing cycles of the subscription that the contract term is for.
|
|
454
461
|
|
|
455
462
|
*/
|
|
456
463
|
|
|
457
|
-
billing_cycle
|
|
464
|
+
billing_cycle:number;
|
|
458
465
|
|
|
459
466
|
/**
|
|
460
467
|
* @description Action to be taken when the contract term completes. \* renew -
|
|
@@ -468,14 +475,14 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
468
475
|
|
|
469
476
|
*/
|
|
470
477
|
|
|
471
|
-
action_at_term_end
|
|
478
|
+
action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
|
|
472
479
|
|
|
473
480
|
/**
|
|
474
481
|
* @description The sum of the [totals](invoices#invoice_total) of all the invoices raised as part of the contract term. For `active` contract terms, this is a predicted value. The value depends on the [type of currency](./#handling_currency_units). If the subscription was [imported](#import_a_subscription) with the contract term, then this value includes the value passed for `total_amount_raised`.
|
|
475
482
|
|
|
476
483
|
*/
|
|
477
484
|
|
|
478
|
-
total_contract_value
|
|
485
|
+
total_contract_value:number;
|
|
479
486
|
|
|
480
487
|
/**
|
|
481
488
|
* @description The number of days before [`contract_end`](contract_terms#contract_term_contract_end), during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
|
|
@@ -2794,6 +2794,13 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
|
|
|
2794
2794
|
*/
|
|
2795
2795
|
|
|
2796
2796
|
charge_on_option?:'on_event' | 'immediately';
|
|
2797
|
+
|
|
2798
|
+
/**
|
|
2799
|
+
* @description null
|
|
2800
|
+
|
|
2801
|
+
*/
|
|
2802
|
+
|
|
2803
|
+
proration_type?:'partial_term' | 'full_term' | 'none';
|
|
2797
2804
|
}
|
|
2798
2805
|
export interface ItemTier {
|
|
2799
2806
|
/**
|