chargebee 2.48.0 → 2.49.1
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 +146 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +15 -2
- package/package.json +1 -1
- package/types/core.d.ts +5 -4
- package/types/index.d.ts +6 -0
- package/types/resources/Addon.d.ts +440 -0
- package/types/resources/CreditNote.d.ts +40 -1
- package/types/resources/CreditNoteEstimate.d.ts +8 -2
- package/types/resources/DifferentialPrice.d.ts +6 -2
- package/types/resources/Estimate.d.ts +6 -4
- package/types/resources/HostedPage.d.ts +227 -893
- package/types/resources/Invoice.d.ts +43 -4
- package/types/resources/InvoiceEstimate.d.ts +40 -1
- package/types/resources/Item.d.ts +5 -1
- package/types/resources/ItemPrice.d.ts +6 -2
- package/types/resources/OmnichannelSubscription.d.ts +5 -5
- package/types/resources/OmnichannelSubscriptionItem.d.ts +42 -1
- package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +36 -0
- package/types/resources/OmnichannelTransaction.d.ts +4 -4
- package/types/resources/PaymentSource.d.ts +7 -0
- package/types/resources/Plan.d.ts +554 -0
- package/types/resources/Quote.d.ts +18 -12
- package/types/resources/QuoteLineGroup.d.ts +12 -322
- package/types/resources/QuotedCharge.d.ts +23 -219
- package/types/resources/QuotedSubscription.d.ts +4 -0
- package/types/resources/Ramp.d.ts +48 -542
- package/types/resources/RecordedPurchase.d.ts +5 -3
- package/types/resources/Subscription.d.ts +7 -3
- package/types/resources/Transaction.d.ts +1 -1
- package/types/resources/UnbilledCharge.d.ts +31 -25
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,149 @@
|
|
|
1
|
+
### v2.49.1 (2025-04-25)
|
|
2
|
+
* * *
|
|
3
|
+
|
|
4
|
+
### Bug fixes:
|
|
5
|
+
* Fixed an issue where the optional boolean field is_percentage_pricing at Item Model was incorrectly marked as required.
|
|
6
|
+
* Fixed an issue where the optional enum field item_applicability at Item Model was incorrectly marked as required.
|
|
7
|
+
|
|
8
|
+
### v2.49.0 (2025-04-23)
|
|
9
|
+
* * *
|
|
10
|
+
|
|
11
|
+
### New Resources:
|
|
12
|
+
* OmnichannelSubscriptionItemScheduledChange has been added.
|
|
13
|
+
|
|
14
|
+
### New Attributes:
|
|
15
|
+
* pricing_type has been added to DifferentialPrice#Tier.
|
|
16
|
+
* package_size has been added to DifferentialPrice#Tier.
|
|
17
|
+
* pricing_type has been added to ItemPrice#Tier.
|
|
18
|
+
* package_size has been added to ItemPrice#Tier.
|
|
19
|
+
* pricing_type has been added to Addon#Tier.
|
|
20
|
+
* package_size has been added to Addon#Tier.
|
|
21
|
+
* pricing_type has been added to Plan#Tier.
|
|
22
|
+
* package_size has been added to Plan#Tier.
|
|
23
|
+
* pricing_type has been added to CreditNote#LineItemTier.
|
|
24
|
+
* package_size has been added to CreditNote#LineItemTier.
|
|
25
|
+
* pricing_type has been added to CreditNoteEstimate#LineItemTier.
|
|
26
|
+
* package_size has been added to CreditNoteEstimate#LineItemTier.
|
|
27
|
+
* pricing_type has been added to DifferentialPrice#Tier.
|
|
28
|
+
* package_size has been added to DifferentialPrice#Tier.
|
|
29
|
+
* pricing_type has been added to Invoice#LineItemTier.
|
|
30
|
+
* package_size has been added to Invoice#LineItemTier.
|
|
31
|
+
* pricing_type has been added to InvoiceEstimate#LineItemTier.
|
|
32
|
+
* package_size has been added to InvoiceEstimate#LineItemTier.
|
|
33
|
+
* pricing_type has been added to Quote#LineItemTier.
|
|
34
|
+
* package_size has been added to Quote#LineItemTier.
|
|
35
|
+
* pricing_type has been added to QuotedCharge#LineItemTier.
|
|
36
|
+
* package_size has been added to QuotedCharge#LineItemTier.
|
|
37
|
+
* pricing_type has been added to QuotedSubscription#LineItemTier.
|
|
38
|
+
* package_size has been added to QuotedSubscription#LineItemTier.
|
|
39
|
+
* pricing_type has been added to Ramp#ItemTier.
|
|
40
|
+
* package_size has been added to Ramp#ItemTier.
|
|
41
|
+
* pricing_type has been added to Subscription#ItemTier.
|
|
42
|
+
* package_size has been added to Subscription#ItemTier.
|
|
43
|
+
* pricing_type has been added to UnbilledCharges#Tier.
|
|
44
|
+
* package_size has been added to UnbilledCharges#Tier.
|
|
45
|
+
* metered has been added to CreditNote#LineItem.
|
|
46
|
+
* metered has been added to CreditNoteEstimate#LineItem.
|
|
47
|
+
* metered has been added to Invoice#LineItem.
|
|
48
|
+
* metered has been added to Quote#LineItem.
|
|
49
|
+
* metered has been added to QuoteLineGroup#LineItem.
|
|
50
|
+
* usage_percentage has been changed to percentage in CreditNote#LineItem.
|
|
51
|
+
* usage_percentage has been changed to percentage in CreditNoteEstimate#LineItem.
|
|
52
|
+
* usage_percentage has been changed to percentage in Invoice#LineItem.
|
|
53
|
+
* usage_percentage has been changed to percentage in Quote#LineItem.
|
|
54
|
+
* usage_percentage has been changed to percentage in QuoteLineGroup#LineItem.
|
|
55
|
+
* line_item_addresses has been added to CreditNote.
|
|
56
|
+
* line_item_addresses has been added to Invoices.
|
|
57
|
+
* line_item_addresses has been added to InvoiceEstimate.
|
|
58
|
+
* has_scheduled_changes has been added on OmnichannelSubscriptionItem.
|
|
59
|
+
* item_parent_id_at_source has been added to OmnichannelSubscriptionItem.
|
|
60
|
+
* auto_renew_status has been added to OmnichannelSubscriptionItem.
|
|
61
|
+
* upcoming_renewal has been added to OmnichannelSubscriptionItem.
|
|
62
|
+
* is_percentage_pricing has been added to Item.
|
|
63
|
+
|
|
64
|
+
### New Action:
|
|
65
|
+
* listOmniSubItemScheduleChanges has been added to OmnichannelSubscriptionItem.
|
|
66
|
+
|
|
67
|
+
### Optional Attribute:
|
|
68
|
+
* price_currency has been made optional from requried in OmnichannelTransaction.
|
|
69
|
+
* price_units has been made optional from requried in OmnichannelTransaction.
|
|
70
|
+
* price_nanos has been made optional from requried in OmnichannelTransaction.
|
|
71
|
+
* transacted_at has been made optional from requried in OmnichannelTransaction.
|
|
72
|
+
|
|
73
|
+
### New Input Params:
|
|
74
|
+
* item_tiers[pricing_type] has been added to DifferentialPrice#CreateInputParam.
|
|
75
|
+
* item_tiers[package_size] has been added to DifferentialPrice#CreateInputParam.
|
|
76
|
+
* item_tiers[pricing_type] has been added to ItemPrice#CreateInputParam.
|
|
77
|
+
* item_tiers[package_size] has been added to ItemPrice#CreateInputParam.
|
|
78
|
+
* tiers[pricing_type] has been added to DifferentialPrice#CreateInputParam.
|
|
79
|
+
* tiers[package_size] has been added to DifferentialPrice#CreateInputParam.
|
|
80
|
+
* item_tiers[pricing_type] has been added to Estimate#CreateSubItemEstimateRequestInputParam.
|
|
81
|
+
* item_tiers[package_size] has been added to Estimate#CreateSubItemEstimateRequestInputParam.
|
|
82
|
+
* item_tiers[pricing_type] has been added to Estimate#CreateSubItemForCustomerRequestInputParam.
|
|
83
|
+
* item_tiers[package_size] has been added to Estimate#CreateSubItemForCustomerRequestInputParam.
|
|
84
|
+
* item_tiers[pricing_type] has been added to Estimate#UpdateSubscriptionForItemsRequestInputParam.
|
|
85
|
+
* item_tiers[package_size] has been added to Estimate#UpdateSubscriptionForItemsRequestInputParam.
|
|
86
|
+
* item_tiers[pricing_type] has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
|
|
87
|
+
* item_tiers[package_size] has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
|
|
88
|
+
* item_tiers[pricing_type] has been added to Estimate#CheckoutNewForItemsRequestInputParam.
|
|
89
|
+
* item_tiers[package_size] has been added to Estimate#CheckoutNewForItemsRequestInputParam.
|
|
90
|
+
* item_tiers[pricing_type] has been added to Estimate#CheckoutOneTimeForItemsRequestInputParam.
|
|
91
|
+
* item_tiers[package_size] has been added to Estimate#CheckoutOneTimeForItemsRequestInputParam.
|
|
92
|
+
* item_tiers[pricing_type] has been added to Estimate#CheckoutExistingForItemsRequestInputParam.
|
|
93
|
+
* item_tiers[package_size] has been added to Estimate#CheckoutExistingForItemsRequestInputParam.
|
|
94
|
+
* item_tiers[pricing_type] has been added to Invoice#CreateForChargeItemsAndChargesRequestInputParam.
|
|
95
|
+
* item_tiers[package_size] has been added to Invoice#CreateForChargeItemsAndChargesRequestInputParam.
|
|
96
|
+
* item_tiers[pricing_type] has been added to Invoice#CreateForChargeItemRequestInputParam.
|
|
97
|
+
* item_tiers[package_size] has been added to Invoice#CreateForChargeItemRequestInputParam.
|
|
98
|
+
* item_tiers[pricing_type] has been added to Invoice#AddChargeItemRequestInputParam.
|
|
99
|
+
* item_tiers[package_size] has been added to Invoice#AddChargeItemRequestInputParam.
|
|
100
|
+
* item_tiers[pricing_type] has been added to Quote#CreateSubItemsForCustomerQuoteRequestInputParam.
|
|
101
|
+
* item_tiers[package_size] has been added to Quote#CreateSubItemsForCustomerQuoteRequestInputParam.
|
|
102
|
+
* item_tiers[pricing_type] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequestInputParam.
|
|
103
|
+
* item_tiers[package_size] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequestInputParam.
|
|
104
|
+
* item_tiers[pricing_type] has been added to Quote#UpdateSubscriptionQuoteForItemsRequestInputParam.
|
|
105
|
+
* item_tiers[package_size] has been added to Quote#UpdateSubscriptionQuoteForItemsRequestInputParam.
|
|
106
|
+
* item_tiers[pricing_type] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequestInputParam.
|
|
107
|
+
* item_tiers[package_size] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequestInputParam.
|
|
108
|
+
* item_tiers[pricing_type] has been added to Quote#CreateForChargeItemsAndChargesRequestInputParam.
|
|
109
|
+
* item_tiers[package_size] has been added to Quote#CreateForChargeItemsAndChargesRequestInputParam.
|
|
110
|
+
* item_tiers[pricing_type] has been added to Quote#EditForChargeItemsAndChargesRequestInputParam.
|
|
111
|
+
* item_tiers[package_size] has been added to Quote#EditForChargeItemsAndChargesRequestInputParam.
|
|
112
|
+
* item_tiers[pricing_type] has been added to Ramp#CreateForSubscriptionRequestInputParam.
|
|
113
|
+
* item_tiers[package_size] has been added to Ramp#CreateForSubscriptionRequestInputParam.
|
|
114
|
+
* item_tiers[pricing_type] has been added to Ramp#UpdateRequestInputParam.
|
|
115
|
+
* item_tiers[package_size] has been added to Ramp#UpdateRequestInputParam.
|
|
116
|
+
* item_tiers[pricing_type] has been added to Subscription#CreateWithItemsRequestInputParam.
|
|
117
|
+
* item_tiers[package_size] has been added to Subscription#CreateWithItemsRequestInputParam.
|
|
118
|
+
* item_tiers[pricing_type] has been added to Subscription#UpdateForItemsRequestInputParam.
|
|
119
|
+
* item_tiers[package_size] has been added to Subscription#UpdateForItemsRequestInputParam.
|
|
120
|
+
* item_tiers[pricing_type] has been added to Subscription#ImportForItemsRequestInputParam.
|
|
121
|
+
* item_tiers[package_size] has been added to Subscription#ImportForItemsRequestInputParam.
|
|
122
|
+
* item_tiers[pricing_type] has been added to UnbilledCharged#CreateRequestInputParam.
|
|
123
|
+
* item_tiers[package_size] has been added to UnbilledCharged#CreateRequestInputParam.
|
|
124
|
+
* billing_address has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
|
|
125
|
+
* google_play_store[purchase_token] has been added to RecordedPurchase#CreateRequestInputParam.
|
|
126
|
+
* is_percentage_pricing has been added to Item#CreateRequest.
|
|
127
|
+
* include_deleted has been added to PaymentSource#ListRequest.
|
|
128
|
+
|
|
129
|
+
### New Enums:
|
|
130
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CHANGE has been added to EntityType#Enum.
|
|
131
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_CHANGE_SCHEDULED has been added to EventType#Enum.
|
|
132
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CHANGE_REMOVED has been added to EventType#Enum.
|
|
133
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_REACTIVATED has been added to EventType#Enum.
|
|
134
|
+
* GOOGLE_PLAY_STORE has been added to OminchannelSubscription#SourceEnum.
|
|
135
|
+
* SPECIFIC_DATE has been added to ContractTermCancelOption.
|
|
136
|
+
* END_OF_SUBSCRIPTION_BILLING_TERM has been added to ContractTermCancelOption.
|
|
137
|
+
* PAYSTACK has been added to GatewayEnum.
|
|
138
|
+
* PricingType Enum has been added.
|
|
139
|
+
* JP_MORGAN has been added to GatewayEnum.
|
|
140
|
+
|
|
141
|
+
### Deprecated Enums:
|
|
142
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADE_SCHEDULED has been deprecated from EntityType#Enum.
|
|
143
|
+
* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_DOWNGRADE_REMOVED has been deprecated from EntityType#Enum.
|
|
144
|
+
* REFUNDED_DUE_TO_APP_ISSUE has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
|
|
145
|
+
* REFUNDED_FOR_OTHER_REASON has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
|
|
146
|
+
|
|
1
147
|
### v2.48.0 (2025-03-06)
|
|
2
148
|
* * *
|
|
3
149
|
|
package/lib/chargebee.js
CHANGED
|
@@ -4655,7 +4655,19 @@ var _endpoints = {
|
|
|
4655
4655
|
]
|
|
4656
4656
|
],
|
|
4657
4657
|
"omnichannel_transaction": [],
|
|
4658
|
-
"omnichannel_subscription_item": [
|
|
4658
|
+
"omnichannel_subscription_item": [
|
|
4659
|
+
[
|
|
4660
|
+
"list_omni_sub_item_schedule_changes",
|
|
4661
|
+
"GET",
|
|
4662
|
+
"/omnichannel_subscription_items",
|
|
4663
|
+
"/scheduled_changes",
|
|
4664
|
+
true,
|
|
4665
|
+
null,
|
|
4666
|
+
false,
|
|
4667
|
+
{
|
|
4668
|
+
}
|
|
4669
|
+
]
|
|
4670
|
+
],
|
|
4659
4671
|
"recorded_purchase": [
|
|
4660
4672
|
[
|
|
4661
4673
|
"create",
|
|
@@ -4718,6 +4730,7 @@ var _endpoints = {
|
|
|
4718
4730
|
"properties": 1,
|
|
4719
4731
|
}
|
|
4720
4732
|
]
|
|
4721
|
-
]
|
|
4733
|
+
],
|
|
4734
|
+
"omnichannel_subscription_item_scheduled_change": []
|
|
4722
4735
|
};
|
|
4723
4736
|
module.exports = _endpoints;
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -29,7 +29,7 @@ declare module 'chargebee' {
|
|
|
29
29
|
type ChargeOnEvent = 'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination' | 'on_demand'
|
|
30
30
|
type ChargeOnOption = 'immediately' | 'on_event'
|
|
31
31
|
type ChargesHandling = 'invoice_immediately' | 'add_to_unbilled_charges'
|
|
32
|
-
type ContractTermCancelOption = 'terminate_immediately' | 'end_of_contract_term'
|
|
32
|
+
type ContractTermCancelOption = 'terminate_immediately' | 'end_of_contract_term' | 'specific_date' | 'end_of_subscription_billing_term'
|
|
33
33
|
type CreditOptionForCurrentTermCharges = 'none' | 'prorate' | 'full'
|
|
34
34
|
type CreditType = 'loyalty_credits' | 'referral_rewards' | 'general'
|
|
35
35
|
type CustomerType = 'residential' | 'business' | 'senior_citizen' | 'industrial'
|
|
@@ -42,13 +42,13 @@ declare module 'chargebee' {
|
|
|
42
42
|
type EinvoicingMethod = 'automatic' | 'manual' | 'site_default'
|
|
43
43
|
type EndScheduleOn = 'after_number_of_intervals' | 'specific_date' | 'subscription_end'
|
|
44
44
|
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
|
|
45
|
-
type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase'
|
|
45
|
+
type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order'
|
|
46
46
|
type EventName = 'cancellation_page_loaded'
|
|
47
|
-
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | '
|
|
47
|
+
type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
48
48
|
type ExportType = 'data' | 'import_friendly_data'
|
|
49
49
|
type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
50
50
|
type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
|
|
51
|
-
type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'gocardless' | 'not_applicable'
|
|
51
|
+
type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'gocardless' | 'not_applicable'
|
|
52
52
|
type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
|
|
53
53
|
type InvoiceDunningHandling = 'continue' | 'stop'
|
|
54
54
|
type ItemType = 'plan' | 'addon' | 'charge'
|
|
@@ -66,6 +66,7 @@ declare module 'chargebee' {
|
|
|
66
66
|
type PeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
67
67
|
type PriceType = 'tax_exclusive' | 'tax_inclusive'
|
|
68
68
|
type PricingModel = 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep'
|
|
69
|
+
type PricingType = 'per_unit' | 'flat_fee' | 'package'
|
|
69
70
|
type ProductCatalogVersion = 'v1' | 'v2'
|
|
70
71
|
type ProrationType = 'full_term' | 'partial_term' | 'none'
|
|
71
72
|
type ReferralSystem = 'referral_candy' | 'referral_saasquatch' | 'friendbuy'
|
package/types/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
///<reference path='./resources/Addon.d.ts' />
|
|
1
2
|
///<reference path='./resources/Address.d.ts' />
|
|
2
3
|
///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
|
|
3
4
|
///<reference path='./resources/AttachedItem.d.ts' />
|
|
@@ -44,6 +45,7 @@
|
|
|
44
45
|
///<reference path='./resources/NonSubscription.d.ts' />
|
|
45
46
|
///<reference path='./resources/OmnichannelSubscription.d.ts' />
|
|
46
47
|
///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
|
|
48
|
+
///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
|
|
47
49
|
///<reference path='./resources/OmnichannelTransaction.d.ts' />
|
|
48
50
|
///<reference path='./resources/Order.d.ts' />
|
|
49
51
|
///<reference path='./resources/PaymentIntent.d.ts' />
|
|
@@ -53,6 +55,7 @@
|
|
|
53
55
|
///<reference path='./resources/PaymentScheduleScheme.d.ts' />
|
|
54
56
|
///<reference path='./resources/PaymentSource.d.ts' />
|
|
55
57
|
///<reference path='./resources/PaymentVoucher.d.ts' />
|
|
58
|
+
///<reference path='./resources/Plan.d.ts' />
|
|
56
59
|
///<reference path='./resources/PortalSession.d.ts' />
|
|
57
60
|
///<reference path='./resources/PriceVariant.d.ts' />
|
|
58
61
|
///<reference path='./resources/PricingPageSession.d.ts' />
|
|
@@ -83,6 +86,7 @@
|
|
|
83
86
|
declare module 'chargebee' {
|
|
84
87
|
export default class {
|
|
85
88
|
static configure({ site, api_key }: { site: string; api_key: string }): void;
|
|
89
|
+
static addon: Addon.AddonResource;
|
|
86
90
|
static address: Address.AddressResource;
|
|
87
91
|
static attached_item: AttachedItem.AttachedItemResource;
|
|
88
92
|
static business_entity: BusinessEntity.BusinessEntityResource;
|
|
@@ -113,11 +117,13 @@ declare module 'chargebee' {
|
|
|
113
117
|
static item_price: ItemPrice.ItemPriceResource;
|
|
114
118
|
static non_subscription: NonSubscription.NonSubscriptionResource;
|
|
115
119
|
static omnichannel_subscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
|
|
120
|
+
static omnichannel_subscription_item: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
|
|
116
121
|
static order: Order.OrderResource;
|
|
117
122
|
static payment_intent: PaymentIntent.PaymentIntentResource;
|
|
118
123
|
static payment_schedule_scheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
|
|
119
124
|
static payment_source: PaymentSource.PaymentSourceResource;
|
|
120
125
|
static payment_voucher: PaymentVoucher.PaymentVoucherResource;
|
|
126
|
+
static plan: Plan.PlanResource;
|
|
121
127
|
static portal_session: PortalSession.PortalSessionResource;
|
|
122
128
|
static price_variant: PriceVariant.PriceVariantResource;
|
|
123
129
|
static pricing_page_session: PricingPageSession.PricingPageSessionResource;
|