chargebee 2.30.0 → 2.32.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 +54 -0
- package/LICENSE +1 -1
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +16 -0
- package/package.json +1 -1
- package/types/core.d.ts +7 -6
- package/types/index.d.ts +2 -0
- package/types/resources/Card.d.ts +2 -2
- package/types/resources/CreditNote.d.ts +23 -2
- package/types/resources/CreditNoteEstimate.d.ts +2 -2
- package/types/resources/Customer.d.ts +98 -74
- package/types/resources/Entitlement.d.ts +78 -0
- package/types/resources/Event.d.ts +1 -1
- package/types/resources/Export.d.ts +7 -7
- package/types/resources/Feature.d.ts +89 -17
- package/types/resources/Hierarchy.d.ts +5 -5
- package/types/resources/HostedPage.d.ts +7 -0
- package/types/resources/Invoice.d.ts +99 -49
- package/types/resources/InvoiceEstimate.d.ts +26 -20
- package/types/resources/ItemPrice.d.ts +21 -0
- package/types/resources/Order.d.ts +85 -4
- package/types/resources/PaymentSource.d.ts +380 -246
- package/types/resources/Quote.d.ts +46 -25
- package/types/resources/QuoteLineGroup.d.ts +23 -17
- package/types/resources/Subscription.d.ts +29 -17
- package/types/resources/SubscriptionEntitlement.d.ts +1 -1
- package/types/resources/SubscriptionEstimate.d.ts +12 -12
- package/types/resources/ThirdPartyPaymentMethod.d.ts +1 -1
- package/types/resources/Transaction.d.ts +35 -3
- package/types/resources/VirtualBankAccount.d.ts +4 -4
|
@@ -45,14 +45,14 @@ declare module 'chargebee' {
|
|
|
45
45
|
invoice_id?:string;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* @description Current status of this quote. \* open - Open \*
|
|
48
|
+
* @description Current status of this quote. \* open - Open \* invoiced - Invoiced \* accepted - Accepted. \* closed - Closed \* declined - Declined.
|
|
49
49
|
|
|
50
50
|
*/
|
|
51
51
|
|
|
52
52
|
status:'declined' | 'invoiced' | 'accepted' | 'closed' | 'open';
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* @description Operation Type \* onetime_invoice - onetime_invoice \*
|
|
55
|
+
* @description Operation Type \* onetime_invoice - onetime_invoice \* create_subscription_for_customer - create_subscription_for_customer \* change_subscription - change_subscription
|
|
56
56
|
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -287,28 +287,28 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
287
287
|
|
|
288
288
|
*/
|
|
289
289
|
|
|
290
|
-
create_sub_items_for_customer_quote(customer_id:string, input
|
|
290
|
+
create_sub_items_for_customer_quote(customer_id:string, input:CreateSubItemsForCustomerQuoteInputParam):ChargebeeRequest<CreateSubItemsForCustomerQuoteResponse>;
|
|
291
291
|
|
|
292
292
|
/**
|
|
293
293
|
* @description Changes the quote produced for creating a new subscription items
|
|
294
294
|
|
|
295
295
|
*/
|
|
296
296
|
|
|
297
|
-
edit_create_sub_customer_quote_for_items(quote_id:string, input
|
|
297
|
+
edit_create_sub_customer_quote_for_items(quote_id:string, input:EditCreateSubCustomerQuoteForItemsInputParam):ChargebeeRequest<EditCreateSubCustomerQuoteForItemsResponse>;
|
|
298
298
|
|
|
299
299
|
/**
|
|
300
300
|
* @description Create a quote for updating subscription line items.
|
|
301
301
|
|
|
302
302
|
*/
|
|
303
303
|
|
|
304
|
-
update_subscription_quote_for_items(input
|
|
304
|
+
update_subscription_quote_for_items(input:UpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<UpdateSubscriptionQuoteForItemsResponse>;
|
|
305
305
|
|
|
306
306
|
/**
|
|
307
307
|
* @description Changes the quote produced for updating the subscription items.
|
|
308
308
|
|
|
309
309
|
*/
|
|
310
310
|
|
|
311
|
-
edit_update_subscription_quote_for_items(quote_id:string, input
|
|
311
|
+
edit_update_subscription_quote_for_items(quote_id:string, input:EditUpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<EditUpdateSubscriptionQuoteForItemsResponse>;
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
314
|
* @description Creates a quote using charge-items and one-time charges.
|
|
@@ -322,7 +322,7 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
322
322
|
|
|
323
323
|
*/
|
|
324
324
|
|
|
325
|
-
edit_for_charge_items_and_charges(quote_id:string, input
|
|
325
|
+
edit_for_charge_items_and_charges(quote_id:string, input:EditForChargeItemsAndChargesInputParam):ChargebeeRequest<EditForChargeItemsAndChargesResponse>;
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
328
|
* @description List all quotes.
|
|
@@ -470,14 +470,14 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
470
470
|
|
|
471
471
|
*/
|
|
472
472
|
|
|
473
|
-
subscription_items
|
|
473
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
474
474
|
|
|
475
475
|
/**
|
|
476
476
|
* @description Parameters for discounts
|
|
477
477
|
|
|
478
478
|
*/
|
|
479
479
|
|
|
480
|
-
discounts
|
|
480
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
481
481
|
|
|
482
482
|
/**
|
|
483
483
|
* @description Parameters for item_tiers
|
|
@@ -568,14 +568,14 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
568
568
|
|
|
569
569
|
*/
|
|
570
570
|
|
|
571
|
-
subscription_items
|
|
571
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
572
572
|
|
|
573
573
|
/**
|
|
574
574
|
* @description Parameters for discounts
|
|
575
575
|
|
|
576
576
|
*/
|
|
577
577
|
|
|
578
|
-
discounts
|
|
578
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
579
579
|
|
|
580
580
|
/**
|
|
581
581
|
* @description Parameters for item_tiers
|
|
@@ -722,7 +722,7 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
722
722
|
|
|
723
723
|
*/
|
|
724
724
|
|
|
725
|
-
subscription
|
|
725
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,id:string,offline_payment_method?:OfflinePaymentMethod,start_date?:number,trial_end?:number};
|
|
726
726
|
|
|
727
727
|
/**
|
|
728
728
|
* @description Parameters for billing_address
|
|
@@ -757,14 +757,14 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
757
757
|
|
|
758
758
|
*/
|
|
759
759
|
|
|
760
|
-
subscription_items
|
|
760
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
761
761
|
|
|
762
762
|
/**
|
|
763
763
|
* @description Parameters for discounts
|
|
764
764
|
|
|
765
765
|
*/
|
|
766
766
|
|
|
767
|
-
discounts
|
|
767
|
+
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}[];
|
|
768
768
|
|
|
769
769
|
/**
|
|
770
770
|
* @description Parameters for item_tiers
|
|
@@ -939,14 +939,14 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
939
939
|
|
|
940
940
|
*/
|
|
941
941
|
|
|
942
|
-
subscription_items
|
|
942
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
943
943
|
|
|
944
944
|
/**
|
|
945
945
|
* @description Parameters for discounts
|
|
946
946
|
|
|
947
947
|
*/
|
|
948
948
|
|
|
949
|
-
discounts
|
|
949
|
+
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}[];
|
|
950
950
|
|
|
951
951
|
/**
|
|
952
952
|
* @description Parameters for item_tiers
|
|
@@ -1051,7 +1051,7 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
1051
1051
|
|
|
1052
1052
|
*/
|
|
1053
1053
|
|
|
1054
|
-
discounts
|
|
1054
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
1055
1055
|
}
|
|
1056
1056
|
export interface EditForChargeItemsAndChargesResponse {
|
|
1057
1057
|
quote:Quote;
|
|
@@ -1135,7 +1135,7 @@ Ireland** . The first two characters of the VAT number in such a case is `X
|
|
|
1135
1135
|
|
|
1136
1136
|
*/
|
|
1137
1137
|
|
|
1138
|
-
discounts
|
|
1138
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
1139
1139
|
}
|
|
1140
1140
|
export interface ListResponse {
|
|
1141
1141
|
/**
|
|
@@ -1448,7 +1448,7 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1448
1448
|
amount?:number;
|
|
1449
1449
|
|
|
1450
1450
|
/**
|
|
1451
|
-
* @description The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. \*
|
|
1451
|
+
* @description The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. \* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in. \* flat_fee - A fixed price that is not quantity-based. \* tiered - The per unit price is based on the tier that the total quantity falls in. \* per_unit - A fixed price per unit quantity. \* volume - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
|
|
1452
1452
|
|
|
1453
1453
|
*/
|
|
1454
1454
|
|
|
@@ -1532,14 +1532,14 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1532
1532
|
entity_description?:string;
|
|
1533
1533
|
|
|
1534
1534
|
/**
|
|
1535
|
-
* @description Specifies the modelled entity this line item is based on. \* addon - Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/addons#addon_attributes) id \* plan_item_price - Indicates that this line item is based on plan Item Price \* addon_item_price - Indicates that this line item is based on addon Item Price \* charge_item_price - Indicates that this line item is based on charge Item Price \* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case \* plan_setup - Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id
|
|
1535
|
+
* @description Specifies the modelled entity this line item is based on. \* addon - Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/addons#addon_attributes) id \* plan - Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* plan_item_price - Indicates that this line item is based on plan Item Price \* addon_item_price - Indicates that this line item is based on addon Item Price \* charge_item_price - Indicates that this line item is based on charge Item Price \* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case \* plan_setup - Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id
|
|
1536
1536
|
|
|
1537
1537
|
*/
|
|
1538
1538
|
|
|
1539
1539
|
entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
|
|
1540
1540
|
|
|
1541
1541
|
/**
|
|
1542
|
-
* @description The reason due to which the line item price/amount is exempted from tax. \* zero_value_item - If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0. \* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only \* tax_not_configured - If tax is not enabled for the site \* high_value_physical_goods - If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied \*
|
|
1542
|
+
* @description The reason due to which the line item price/amount is exempted from tax. \* zero_value_item - If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0. \* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only \* tax_not_configured - If tax is not enabled for the site \* high_value_physical_goods - If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied \* customer_exempt - If the Customer is marked as Tax exempt \* region_non_taxable - If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction \* product_exempt - If the Plan or Addon is marked as Tax exempt \* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item \* export - You are not registered for tax in the customer's region. This is also the reason code when both `billing_address` and `shipping_address` have not been provided for the customer and subscription respectively
|
|
1543
1543
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
|
|
@@ -1582,7 +1582,7 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1582
1582
|
line_item_id?:string;
|
|
1583
1583
|
|
|
1584
1584
|
/**
|
|
1585
|
-
* @description The type of deduction and the amount to which it is applied. \*
|
|
1585
|
+
* @description The type of deduction and the amount to which it is applied. \* prorated_credits - The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id` is `null` in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices?prod_cat_ver=2#invoice_adjustment_credit_notes). \* item_level_coupon - The deduction is due to a coupon applied to line item. The coupon `id` is passed as `entity_id`. \* item_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to a line item of the invoice. The discount `id` is available as the `entity_id`. \* document_level_coupon - The deduction is due to a coupon applied to the invoice `sub_total`. The coupon id is passed as `entity_id`. \* promotional_credits - The deduction is due to a [promotional credit](/docs/api/promotional_credits?prod_cat_ver=2) applied to the invoice. \* document_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to the invoice `sub_total`. The discount `id` is available as the `entity_id`.
|
|
1586
1586
|
|
|
1587
1587
|
*/
|
|
1588
1588
|
|
|
@@ -1618,7 +1618,7 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1618
1618
|
line_item_id:string;
|
|
1619
1619
|
|
|
1620
1620
|
/**
|
|
1621
|
-
* @description The type of deduction and the amount to which it is applied. \*
|
|
1621
|
+
* @description The type of deduction and the amount to which it is applied. \* prorated_credits - The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id` is `null` in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices?prod_cat_ver=2#invoice_adjustment_credit_notes). \* document_level_coupon - The deduction is due to a coupon applied to the invoice `sub_total`. The coupon `id` is available as `entity_id`. \* promotional_credits - The deduction is due to a [promotional credit](/docs/api/promotional_credits) applied to the invoice. The `entity_id` is `null` in this case. \* item_level_coupon - The deduction is due to a coupon applied to a line item of the invoice. The coupon `id` is available as `entity_id`. \* document_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to the invoice `sub_total`. The discount `id` is available as the `entity_id`. \* item_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to a line item of the invoice. The discount `id` is available as the `entity_id`.
|
|
1622
1622
|
|
|
1623
1623
|
*/
|
|
1624
1624
|
|
|
@@ -1684,6 +1684,27 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1684
1684
|
|
|
1685
1685
|
tax_rate:number;
|
|
1686
1686
|
|
|
1687
|
+
/**
|
|
1688
|
+
* @description Indicates the service period end of the tax rate for the line item.
|
|
1689
|
+
|
|
1690
|
+
*/
|
|
1691
|
+
|
|
1692
|
+
date_to?:number;
|
|
1693
|
+
|
|
1694
|
+
/**
|
|
1695
|
+
* @description Indicates the service period start of the tax rate for the line item.
|
|
1696
|
+
|
|
1697
|
+
*/
|
|
1698
|
+
|
|
1699
|
+
date_from?:number;
|
|
1700
|
+
|
|
1701
|
+
/**
|
|
1702
|
+
* @description Indicates the prorated line item amount in cents.
|
|
1703
|
+
|
|
1704
|
+
*/
|
|
1705
|
+
|
|
1706
|
+
prorated_taxable_amount?:number;
|
|
1707
|
+
|
|
1687
1708
|
/**
|
|
1688
1709
|
* @description Indicates if tax is applied only on a portion of the line item amount.
|
|
1689
1710
|
|
|
@@ -1713,7 +1734,7 @@ This parameter is passed only when there are metered items in the subscription o
|
|
|
1713
1734
|
tax_amount:number;
|
|
1714
1735
|
|
|
1715
1736
|
/**
|
|
1716
|
-
* @description The type of tax jurisdiction \*
|
|
1737
|
+
* @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.
|
|
1717
1738
|
|
|
1718
1739
|
*/
|
|
1719
1740
|
|
|
@@ -1911,7 +1932,7 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
|
|
|
1911
1932
|
zip?:string;
|
|
1912
1933
|
|
|
1913
1934
|
/**
|
|
1914
|
-
* @description The address verification status. \*
|
|
1935
|
+
* @description The address verification status. \* not_validated - Address is not yet validated. \* valid - Address was validated successfully. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* invalid - Address is invalid.
|
|
1915
1936
|
|
|
1916
1937
|
*/
|
|
1917
1938
|
|
|
@@ -123,21 +123,21 @@ declare module 'chargebee' {
|
|
|
123
123
|
|
|
124
124
|
*/
|
|
125
125
|
|
|
126
|
-
date_from
|
|
126
|
+
date_from:number;
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
129
|
* @description End date of this line item.
|
|
130
130
|
|
|
131
131
|
*/
|
|
132
132
|
|
|
133
|
-
date_to
|
|
133
|
+
date_to:number;
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
136
|
* @description Unit amount of the line item.
|
|
137
137
|
|
|
138
138
|
*/
|
|
139
139
|
|
|
140
|
-
unit_amount
|
|
140
|
+
unit_amount:number;
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
143
|
* @description [Quantity of the recurring item](/docs/api/invoices?prod_cat_ver=2#invoice_line_items_quantity) which is represented by this line item. For `metered` line items, this value is updated from [usages](/docs/api/usages) once when the invoice is generated as `pending` and finally when the invoice is [closed](/docs/api/invoices#close_a_pending_invoice).
|
|
@@ -165,7 +165,7 @@ declare module 'chargebee' {
|
|
|
165
165
|
|
|
166
166
|
*/
|
|
167
167
|
|
|
168
|
-
is_taxed
|
|
168
|
+
is_taxed:boolean;
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* @description The tax amount charged for this item
|
|
@@ -228,7 +228,7 @@ declare module 'chargebee' {
|
|
|
228
228
|
|
|
229
229
|
*/
|
|
230
230
|
|
|
231
|
-
description
|
|
231
|
+
description:string;
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
234
|
* @description Detailed description about this item.
|
|
@@ -242,7 +242,7 @@ declare module 'chargebee' {
|
|
|
242
242
|
|
|
243
243
|
*/
|
|
244
244
|
|
|
245
|
-
entity_type
|
|
245
|
+
entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
|
|
246
246
|
|
|
247
247
|
/**
|
|
248
248
|
* @description The reason due to which the line item price/amount is exempted from tax. \* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only \* tax_not_configured - If tax is not enabled for the site \* high_value_physical_goods - If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied \* product_exempt - If the Plan or Addon is marked as Tax exempt \* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item \* customer_exempt - If the Customer is marked as Tax exempt \* region_non_taxable - If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction \* export - You are not registered for tax in the customer's region. This is also the reason code when both `billing_address` and `shipping_address` have not been provided for the customer and subscription respectively
|
|
@@ -271,7 +271,7 @@ declare module 'chargebee' {
|
|
|
271
271
|
|
|
272
272
|
*/
|
|
273
273
|
|
|
274
|
-
amount
|
|
274
|
+
amount:number;
|
|
275
275
|
|
|
276
276
|
/**
|
|
277
277
|
* @description Description for this deduction.
|
|
@@ -292,7 +292,7 @@ declare module 'chargebee' {
|
|
|
292
292
|
|
|
293
293
|
*/
|
|
294
294
|
|
|
295
|
-
entity_type
|
|
295
|
+
entity_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
|
|
296
296
|
|
|
297
297
|
/**
|
|
298
298
|
* @description The type of discount that is applied to the line item. Relevant only when `discounts[entity_type]` is one of `item_level_discount` , `item_level_coupon`, `document_level_discount`, or `document_level_coupon` \* percentage - when percentage is applied as discount \* fixed_amount - when amount is applied as discount
|
|
@@ -321,14 +321,14 @@ declare module 'chargebee' {
|
|
|
321
321
|
|
|
322
322
|
*/
|
|
323
323
|
|
|
324
|
-
line_item_id
|
|
324
|
+
line_item_id:string;
|
|
325
325
|
|
|
326
326
|
/**
|
|
327
327
|
* @description The type of deduction and the amount to which it is applied. \* item_level_coupon - The deduction is due to a coupon applied to a line item of the invoice. The coupon `id` is available as `entity_id`. \* prorated_credits - The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id` is `null` in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices?prod_cat_ver=2#invoice_adjustment_credit_notes). \* document_level_coupon - The deduction is due to a coupon applied to the invoice `sub_total`. The coupon `id` is available as `entity_id`. \* document_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to the invoice `sub_total`. The discount `id` is available as the `entity_id`. \* item_level_discount - The deduction is due to a [discount](/docs/api/discounts?prod_cat_ver=2) applied to a line item of the invoice. The discount `id` is available as the `entity_id`. \* promotional_credits - The deduction is due to a [promotional credit](/docs/api/promotional_credits) applied to the invoice. The `entity_id` is `null` in this case.
|
|
328
328
|
|
|
329
329
|
*/
|
|
330
330
|
|
|
331
|
-
discount_type
|
|
331
|
+
discount_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
|
|
332
332
|
|
|
333
333
|
coupon_id?:string;
|
|
334
334
|
|
|
@@ -344,7 +344,7 @@ declare module 'chargebee' {
|
|
|
344
344
|
|
|
345
345
|
*/
|
|
346
346
|
|
|
347
|
-
discount_amount
|
|
347
|
+
discount_amount:number;
|
|
348
348
|
}
|
|
349
349
|
export interface Tax {
|
|
350
350
|
/**
|
|
@@ -352,14 +352,14 @@ declare module 'chargebee' {
|
|
|
352
352
|
|
|
353
353
|
*/
|
|
354
354
|
|
|
355
|
-
name
|
|
355
|
+
name:string;
|
|
356
356
|
|
|
357
357
|
/**
|
|
358
358
|
* @description The tax amount.
|
|
359
359
|
|
|
360
360
|
*/
|
|
361
361
|
|
|
362
|
-
amount
|
|
362
|
+
amount:number;
|
|
363
363
|
|
|
364
364
|
/**
|
|
365
365
|
* @description Description of the tax item.
|
|
@@ -381,14 +381,20 @@ declare module 'chargebee' {
|
|
|
381
381
|
|
|
382
382
|
*/
|
|
383
383
|
|
|
384
|
-
tax_name
|
|
384
|
+
tax_name:string;
|
|
385
385
|
|
|
386
386
|
/**
|
|
387
387
|
* @description The rate of tax used to calculate tax amount
|
|
388
388
|
|
|
389
389
|
*/
|
|
390
390
|
|
|
391
|
-
tax_rate
|
|
391
|
+
tax_rate:number;
|
|
392
|
+
|
|
393
|
+
date_to?:number;
|
|
394
|
+
|
|
395
|
+
date_from?:number;
|
|
396
|
+
|
|
397
|
+
prorated_taxable_amount?:number;
|
|
392
398
|
|
|
393
399
|
/**
|
|
394
400
|
* @description Indicates if tax is applied only on a portion of the line item amount.
|
|
@@ -409,14 +415,14 @@ declare module 'chargebee' {
|
|
|
409
415
|
|
|
410
416
|
*/
|
|
411
417
|
|
|
412
|
-
taxable_amount
|
|
418
|
+
taxable_amount:number;
|
|
413
419
|
|
|
414
420
|
/**
|
|
415
421
|
* @description The tax amount
|
|
416
422
|
|
|
417
423
|
*/
|
|
418
424
|
|
|
419
|
-
tax_amount
|
|
425
|
+
tax_amount:number;
|
|
420
426
|
|
|
421
427
|
/**
|
|
422
428
|
* @description The type of tax jurisdiction \* unincorporated - Combined tax of state and county. \* 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 \* other - Jurisdictions other than the ones listed above. \* special - Special tax jurisdiction.
|
|
@@ -67,11 +67,11 @@ declare module 'chargebee' {
|
|
|
67
67
|
customer_id:string;
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
|
-
* @description Current state of the subscription \* future - The subscription is scheduled to start at a future date. \* non_renewing - The subscription will be canceled at the end of the current term. \* active - The subscription is active and will be charged for automatically based on the items in it. \* cancelled - The subscription has been canceled and is no longer in service. \* in_trial - The subscription is in trial. \* paused - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.
|
|
70
|
+
* @description Current state of the subscription \* future - The subscription is scheduled to start at a future date. \* non_renewing - The subscription will be canceled at the end of the current term. \* active - The subscription is active and will be charged for automatically based on the items in it. \* cancelled - The subscription has been canceled and is no longer in service. \* transferred - The `transferred` status will be reflected on the source business entity's subscription attribute once the [customer transfer](https://www.chargebee.com/docs/2.0/mbe-getting-started-with-customer-transfer.html) activity is completed successfully. This status is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html) as the Multiple Business Entity features can only be enabled for product catalog 2.0. \* in_trial - The subscription is in trial. \* paused - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.
|
|
71
71
|
|
|
72
72
|
*/
|
|
73
73
|
|
|
74
|
-
status:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
74
|
+
status:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
77
|
* @description Start of the trial period for the subscription. Presence of this value for `future` subscription implies the subscription will go into `in_trial` state when it starts.
|
|
@@ -248,6 +248,18 @@ declare module 'chargebee' {
|
|
|
248
248
|
|
|
249
249
|
net_term_days?:number;
|
|
250
250
|
|
|
251
|
+
/**
|
|
252
|
+
* @description This attribute represents the identifier of the most recent version of the [subscriptions](/docs/api/subscriptions) resource. When interacting with our API, the `active_id` ensures you are always referencing the current and most up-to-date version of the [subscriptions](/docs/api/subscriptions) resource. This mechanism is in place to maintain consistent external references and data integrity across business entity changes and updates. `active_id` is present on the resource after the resource is transferred to the destination business entity and it will refer to the most recent version of the resource. Learn more about the [customer transfer feature](https://www.chargebee.com/docs/2.0/mbe-customer-transfer-overview.html) and [setup](https://www.chargebee.com/docs/2.0/mbe-getting-started-with-customer-transfer.html).
|
|
253
|
+
**Note:**
|
|
254
|
+
|
|
255
|
+
* If `active_id` and `id` of the subscription are the same, then it is the most recent version of the resource.
|
|
256
|
+
* If `active_id` and `id` of the subscription are different, then it is a transferred resource.
|
|
257
|
+
* If `active_id` is not present, then the resource is not transferred and there are no business entity-related changes.
|
|
258
|
+
|
|
259
|
+
*/
|
|
260
|
+
|
|
261
|
+
active_id?:string;
|
|
262
|
+
|
|
251
263
|
/**
|
|
252
264
|
* @description Total number of invoices that are due for payment against the subscription.
|
|
253
265
|
**Note:** Not supported if [consolidated invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html) is enabled, or when the subscription is for the customer who is in [hierarchy](./hierarchies), and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of `due_invoices_count`.
|
|
@@ -441,7 +453,7 @@ Creates a new subscription for an existing customer in Chargebee. Any available
|
|
|
441
453
|
|
|
442
454
|
*/
|
|
443
455
|
|
|
444
|
-
create_with_items(customer_id:string, input
|
|
456
|
+
create_with_items(customer_id:string, input:CreateWithItemsInputParam):ChargebeeRequest<CreateWithItemsResponse>;
|
|
445
457
|
|
|
446
458
|
/**
|
|
447
459
|
* @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
|
|
@@ -523,7 +535,7 @@ Updates the specified subscription by setting the parameters passed. Any paramet
|
|
|
523
535
|
|
|
524
536
|
*/
|
|
525
537
|
|
|
526
|
-
update_for_items(subscription_id:string, input
|
|
538
|
+
update_for_items(subscription_id:string, input:UpdateForItemsInputParam):ChargebeeRequest<UpdateForItemsResponse>;
|
|
527
539
|
|
|
528
540
|
/**
|
|
529
541
|
* @description Changes the subscription's current term end date. Depending on the "status" of the subscription, "term end date" has different effects.
|
|
@@ -636,7 +648,7 @@ For contract terms in `active` state, import is allowed only if the as
|
|
|
636
648
|
|
|
637
649
|
*/
|
|
638
650
|
|
|
639
|
-
import_unbilled_charges(subscription_id:string, input
|
|
651
|
+
import_unbilled_charges(subscription_id:string, input:ImportUnbilledChargesInputParam):ChargebeeRequest<ImportUnbilledChargesResponse>;
|
|
640
652
|
|
|
641
653
|
/**
|
|
642
654
|
* @description Imports a subscription into Chargebee.
|
|
@@ -1007,14 +1019,14 @@ Creates a new subscription for an existing customer in Chargebee. Any available
|
|
|
1007
1019
|
|
|
1008
1020
|
*/
|
|
1009
1021
|
|
|
1010
|
-
subscription_items
|
|
1022
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
1011
1023
|
|
|
1012
1024
|
/**
|
|
1013
1025
|
* @description Parameters for discounts
|
|
1014
1026
|
|
|
1015
1027
|
*/
|
|
1016
1028
|
|
|
1017
|
-
discounts
|
|
1029
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
1018
1030
|
|
|
1019
1031
|
/**
|
|
1020
1032
|
* @description Parameters for item_tiers
|
|
@@ -1094,7 +1106,7 @@ Creates a new subscription for an existing customer in Chargebee. Any available
|
|
|
1094
1106
|
|
|
1095
1107
|
*/
|
|
1096
1108
|
|
|
1097
|
-
status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string};
|
|
1109
|
+
status?:{in?:string,is?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string};
|
|
1098
1110
|
|
|
1099
1111
|
/**
|
|
1100
1112
|
* @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
|
|
@@ -1164,7 +1176,7 @@ Creates a new subscription for an existing customer in Chargebee. Any available
|
|
|
1164
1176
|
|
|
1165
1177
|
*/
|
|
1166
1178
|
|
|
1167
|
-
offline_payment_method?:{in?:string,is?:'bank_transfer' | '
|
|
1179
|
+
offline_payment_method?:{in?:string,is?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',not_in?:string};
|
|
1168
1180
|
|
|
1169
1181
|
/**
|
|
1170
1182
|
* @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
|
|
@@ -1685,14 +1697,14 @@ Updates the specified subscription by setting the parameters passed. Any paramet
|
|
|
1685
1697
|
|
|
1686
1698
|
*/
|
|
1687
1699
|
|
|
1688
|
-
subscription_items
|
|
1700
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
1689
1701
|
|
|
1690
1702
|
/**
|
|
1691
1703
|
* @description Parameters for discounts
|
|
1692
1704
|
|
|
1693
1705
|
*/
|
|
1694
1706
|
|
|
1695
|
-
discounts
|
|
1707
|
+
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}[];
|
|
1696
1708
|
|
|
1697
1709
|
/**
|
|
1698
1710
|
* @description Parameters for item_tiers
|
|
@@ -2094,21 +2106,21 @@ When dunning (payment failure retry settings) is configured with the last retry
|
|
|
2094
2106
|
|
|
2095
2107
|
*/
|
|
2096
2108
|
|
|
2097
|
-
unbilled_charges
|
|
2109
|
+
unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
|
|
2098
2110
|
|
|
2099
2111
|
/**
|
|
2100
2112
|
* @description Parameters for discounts
|
|
2101
2113
|
|
|
2102
2114
|
*/
|
|
2103
2115
|
|
|
2104
|
-
discounts
|
|
2116
|
+
discounts:{amount:number,description?:string,entity_id?:string,entity_type?:'item_level_coupon' | 'item_level_discount' | 'document_level_discount' | 'document_level_coupon',unbilled_charge_id?:string}[];
|
|
2105
2117
|
|
|
2106
2118
|
/**
|
|
2107
2119
|
* @description Parameters for tiers
|
|
2108
2120
|
|
|
2109
2121
|
*/
|
|
2110
2122
|
|
|
2111
|
-
tiers
|
|
2123
|
+
tiers:{ending_unit?:number,ending_unit_in_decimal?:string,quantity_used?:number,quantity_used_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string,unbilled_charge_id:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
2112
2124
|
}
|
|
2113
2125
|
export interface ImportForItemsResponse {
|
|
2114
2126
|
subscription:Subscription;
|
|
@@ -2193,7 +2205,7 @@ When dunning (payment failure retry settings) is configured with the last retry
|
|
|
2193
2205
|
|
|
2194
2206
|
*/
|
|
2195
2207
|
|
|
2196
|
-
status:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
2208
|
+
status:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing';
|
|
2197
2209
|
|
|
2198
2210
|
/**
|
|
2199
2211
|
* @description End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
|
|
@@ -2358,14 +2370,14 @@ Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_bi
|
|
|
2358
2370
|
|
|
2359
2371
|
*/
|
|
2360
2372
|
|
|
2361
|
-
subscription_items
|
|
2373
|
+
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
2362
2374
|
|
|
2363
2375
|
/**
|
|
2364
2376
|
* @description Parameters for discounts
|
|
2365
2377
|
|
|
2366
2378
|
*/
|
|
2367
2379
|
|
|
2368
|
-
discounts
|
|
2380
|
+
discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
2369
2381
|
|
|
2370
2382
|
/**
|
|
2371
2383
|
* @description Parameters for charged_items
|