chargebee 2.53.1 → 2.54.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 +55 -0
- package/lib/chargebee.js +2 -2
- package/lib/resources/api_endpoints.js +73 -0
- package/package.json +1 -1
- package/types/core.d.ts +4 -2
- package/types/index.d.ts +7 -0
- package/types/resources/Comment.d.ts +1 -1
- package/types/resources/CreditNote.d.ts +3 -5
- package/types/resources/CreditNoteEstimate.d.ts +40 -40
- package/types/resources/Currency.d.ts +23 -6
- package/types/resources/Customer.d.ts +2 -0
- package/types/resources/Estimate.d.ts +2 -2
- package/types/resources/Event.d.ts +1 -1
- package/types/resources/GatewayErrorDetail.d.ts +2 -0
- package/types/resources/HostedPage.d.ts +3 -3
- package/types/resources/Invoice.d.ts +5 -7
- package/types/resources/InvoiceEstimate.d.ts +52 -52
- package/types/resources/OfferEvent.d.ts +22 -0
- package/types/resources/OfferFulfillment.d.ts +68 -0
- package/types/resources/OmnichannelOneTimeOrder.d.ts +2 -22
- package/types/resources/OmnichannelSubscription.d.ts +9 -20
- package/types/resources/OmnichannelSubscriptionItem.d.ts +2 -0
- package/types/resources/OmnichannelSubscriptionItemOffer.d.ts +38 -0
- package/types/resources/OmnichannelTransaction.d.ts +14 -0
- package/types/resources/Order.d.ts +0 -2
- package/types/resources/PersonalizedOffer.d.ts +64 -0
- package/types/resources/Quote.d.ts +35 -37
- package/types/resources/QuoteLineGroup.d.ts +24 -24
- package/types/resources/Ramp.d.ts +32 -7
- package/types/resources/Subscription.d.ts +2 -2
- package/types/resources/SubscriptionEstimate.d.ts +0 -2
- package/types/resources/Transaction.d.ts +2 -0
- package/types/resources/UsageFile.d.ts +4 -0
- package/types/resources/WebhookEndpoint.d.ts +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,58 @@
|
|
|
1
|
+
### v2.54.0 (2025-09-23)
|
|
2
|
+
|
|
3
|
+
### New Resources:
|
|
4
|
+
* PersonalizedOffer has been added.
|
|
5
|
+
* OfferFulfillment has been added.
|
|
6
|
+
* OfferEvent has been added.
|
|
7
|
+
* OmnichannelSubscriptionItemOffer has been added.
|
|
8
|
+
|
|
9
|
+
### New Attributes:
|
|
10
|
+
* business_entity_id has been added to Customer#Balance.
|
|
11
|
+
* processor_advice_code has been added to GatewayErrorDetail.
|
|
12
|
+
* processor_advice_code has been added to Transaction#GatewayErrorDetail.
|
|
13
|
+
* omnichannel_subscription_item_offers has been added to OmnichannelSubscriptionItem.
|
|
14
|
+
* linked_omnichannel_subscriptions has been added to OmnichannelTransaction.
|
|
15
|
+
* linked_omnichannel_one_time_orders has been added to OmnichannelTransaction.
|
|
16
|
+
* contract_term has been added to Ramp.
|
|
17
|
+
* charge_once has been added to Ramp#ItemsToAdd.
|
|
18
|
+
* charge_on_option has been added to Ramp#ItemsToAdd.
|
|
19
|
+
* charge_on_event has been added to Ramp#ItemsToAdd.
|
|
20
|
+
* charge_once has been added to Ramp#ItemsToUpdate.
|
|
21
|
+
* charge_on_option has been added to Ramp#ItemsToUpdate.
|
|
22
|
+
* charge_on_event has been added to Ramp#ItemsToUpdate.
|
|
23
|
+
* error_file_path has been added to UsageFile.
|
|
24
|
+
* error_file_url has been added to UsageFile.
|
|
25
|
+
|
|
26
|
+
### New Endpoint:
|
|
27
|
+
* move has been added to OmnichannelSubscription.
|
|
28
|
+
|
|
29
|
+
### New Parameters:
|
|
30
|
+
* offline_payment_method has been added to Estimate#CreateSubItemEstimateRequest.
|
|
31
|
+
* offline_payment_method has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
|
|
32
|
+
* offline_payment_method has been added to HostedPage#CheckoutNewForItemsRequest.
|
|
33
|
+
* offline_payment_method has been added to Quote#SubscriptionCreateSubItemsForCustomerQuoteRequest.
|
|
34
|
+
* offline_payment_method has been added to Quote#SubscriptionEditCreateSubCustomerQuoteForItemsRequest.
|
|
35
|
+
* contract_term has been added to Ramp#CreateForSubscriptionRequest.
|
|
36
|
+
* items_to_add has been added to Ramp#CreateForSubscriptionRequest.
|
|
37
|
+
* items_to_update has been added to Ramp#CreateForSubscriptionRequest.
|
|
38
|
+
* contract_term has been added to Ramp#UpdateRequest.
|
|
39
|
+
* items_to_add has been added to Ramp#UpdateRequest.
|
|
40
|
+
* items_to_update has been added to Ramp#UpdateRequest.
|
|
41
|
+
|
|
42
|
+
### New Enums:
|
|
43
|
+
* DUNNING_UPDATED has been added EventType.
|
|
44
|
+
* OMNICHANNEL_SUBSCRIPTION_MOVED_IN has been added to EventType.
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Bug Fixes:
|
|
48
|
+
* currency list action has been marked as ListRequest.
|
|
49
|
+
* index has been removed from CreditNote#ShippingAddress.
|
|
50
|
+
* index has been removed from Invoice#ShippingAddress
|
|
51
|
+
* index has been removed from Order#ShippingAddress.
|
|
52
|
+
* index has been removed from Quote#ShippingAddress.
|
|
53
|
+
* index has been removed from SubscriptionEstimate#ShippingAddress.
|
|
54
|
+
* index has been removed from Subscription#ShippingAddress.
|
|
55
|
+
|
|
1
56
|
### v2.53.1 (2025-08-22)
|
|
2
57
|
* * *
|
|
3
58
|
|
package/lib/chargebee.js
CHANGED
|
@@ -11,7 +11,7 @@ ChargeBee._env = {
|
|
|
11
11
|
hostSuffix: '.chargebee.com',
|
|
12
12
|
apiPath: '/api/v2',
|
|
13
13
|
timeout: 80000,
|
|
14
|
-
clientVersion: 'v2.
|
|
14
|
+
clientVersion: 'v2.54.0',
|
|
15
15
|
port: 443,
|
|
16
16
|
timemachineWaitInMillis: 3000,
|
|
17
17
|
exportWaitInMillis: 3000
|
|
@@ -199,7 +199,7 @@ ChargeBee._core = (function() {
|
|
|
199
199
|
});
|
|
200
200
|
res.on('end', function() {
|
|
201
201
|
try {
|
|
202
|
-
response = JSON.parse(response);
|
|
202
|
+
response = res.statusCode == 204 ? res : JSON.parse(response);
|
|
203
203
|
} catch (e) {
|
|
204
204
|
if (response.includes('503')) {
|
|
205
205
|
return throwError(
|
|
@@ -4687,6 +4687,17 @@ var _endpoints = {
|
|
|
4687
4687
|
false,
|
|
4688
4688
|
{
|
|
4689
4689
|
}
|
|
4690
|
+
],
|
|
4691
|
+
[
|
|
4692
|
+
"move",
|
|
4693
|
+
"POST",
|
|
4694
|
+
"/omnichannel_subscriptions",
|
|
4695
|
+
"/move",
|
|
4696
|
+
true,
|
|
4697
|
+
null,
|
|
4698
|
+
false,
|
|
4699
|
+
{
|
|
4700
|
+
}
|
|
4690
4701
|
]
|
|
4691
4702
|
],
|
|
4692
4703
|
"omnichannel_transaction": [],
|
|
@@ -4816,7 +4827,69 @@ var _endpoints = {
|
|
|
4816
4827
|
}
|
|
4817
4828
|
]
|
|
4818
4829
|
],
|
|
4830
|
+
"personalized_offer": [
|
|
4831
|
+
[
|
|
4832
|
+
"personalized_offers",
|
|
4833
|
+
"POST",
|
|
4834
|
+
"/personalized_offers",
|
|
4835
|
+
null,
|
|
4836
|
+
false,
|
|
4837
|
+
"grow",
|
|
4838
|
+
true,
|
|
4839
|
+
{
|
|
4840
|
+
"custom": 0,
|
|
4841
|
+
}
|
|
4842
|
+
]
|
|
4843
|
+
],
|
|
4819
4844
|
"brand": [],
|
|
4845
|
+
"offer_fulfillment": [
|
|
4846
|
+
[
|
|
4847
|
+
"offer_fulfillments",
|
|
4848
|
+
"POST",
|
|
4849
|
+
"/offer_fulfillments",
|
|
4850
|
+
null,
|
|
4851
|
+
false,
|
|
4852
|
+
"grow",
|
|
4853
|
+
true,
|
|
4854
|
+
{
|
|
4855
|
+
}
|
|
4856
|
+
],
|
|
4857
|
+
[
|
|
4858
|
+
"offer_fulfillments_get",
|
|
4859
|
+
"GET",
|
|
4860
|
+
"/offer_fulfillments",
|
|
4861
|
+
null,
|
|
4862
|
+
true,
|
|
4863
|
+
"grow",
|
|
4864
|
+
true,
|
|
4865
|
+
{
|
|
4866
|
+
}
|
|
4867
|
+
],
|
|
4868
|
+
[
|
|
4869
|
+
"offer_fulfillments_update",
|
|
4870
|
+
"POST",
|
|
4871
|
+
"/offer_fulfillments",
|
|
4872
|
+
null,
|
|
4873
|
+
true,
|
|
4874
|
+
"grow",
|
|
4875
|
+
true,
|
|
4876
|
+
{
|
|
4877
|
+
}
|
|
4878
|
+
]
|
|
4879
|
+
],
|
|
4880
|
+
"offer_event": [
|
|
4881
|
+
[
|
|
4882
|
+
"offer_events",
|
|
4883
|
+
"POST",
|
|
4884
|
+
"/offer_events",
|
|
4885
|
+
null,
|
|
4886
|
+
false,
|
|
4887
|
+
"grow",
|
|
4888
|
+
true,
|
|
4889
|
+
{
|
|
4890
|
+
}
|
|
4891
|
+
]
|
|
4892
|
+
],
|
|
4820
4893
|
"webhook_endpoint": [
|
|
4821
4894
|
[
|
|
4822
4895
|
"create",
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -25,6 +25,7 @@ declare module 'chargebee' {
|
|
|
25
25
|
type BillingPeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
26
26
|
type BillingStartOption = 'immediately' | 'on_specific_date'
|
|
27
27
|
type CancelOption = 'immediately' | 'end_of_term' | 'specific_date' | 'end_of_billing_term'
|
|
28
|
+
type Category = 'introductory' | 'promotional' | 'developer_determined'
|
|
28
29
|
type ChangeOption = 'immediately' | 'end_of_term' | 'specific_date'
|
|
29
30
|
type Channel = 'web' | 'app_store' | 'play_store'
|
|
30
31
|
type ChargeModel = 'full_charge' | 'prorate'
|
|
@@ -38,6 +39,7 @@ declare module 'chargebee' {
|
|
|
38
39
|
type CustomerType = 'residential' | 'business' | 'senior_citizen' | 'industrial'
|
|
39
40
|
type DedupeOption = 'skip' | 'update_existing'
|
|
40
41
|
type DirectDebitScheme = 'ach' | 'bacs' | 'sepa_core' | 'autogiro' | 'becs' | 'becs_nz' | 'pad' | 'not_applicable'
|
|
42
|
+
type DiscountType = 'fixed_amount' | 'percentage' | 'price'
|
|
41
43
|
type DispositionType = 'attachment' | 'inline'
|
|
42
44
|
type DunningType = 'auto_collect' | 'offline' | 'direct_debit'
|
|
43
45
|
type DurationType = 'one_time' | 'forever' | 'limited_period'
|
|
@@ -47,7 +49,7 @@ declare module 'chargebee' {
|
|
|
47
49
|
type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
|
|
48
50
|
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' | 'omnichannel_one_time_order' | 'omnichannel_one_time_order_item' | 'usage_file'
|
|
49
51
|
type EventName = 'cancellation_page_loaded'
|
|
50
|
-
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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
52
|
+
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' | 'dunning_updated' | '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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled' | 'omnichannel_subscription_moved_in' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
|
|
51
53
|
type ExportType = 'data' | 'import_friendly_data'
|
|
52
54
|
type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
|
|
53
55
|
type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
|
|
@@ -86,7 +88,7 @@ declare module 'chargebee' {
|
|
|
86
88
|
type Taxability = 'taxable' | 'exempt'
|
|
87
89
|
type TaxjarExemptionCategory = 'wholesale' | 'government' | 'other'
|
|
88
90
|
type TrialEndAction = 'site_default' | 'plan_default' | 'activate_subscription' | 'cancel_subscription'
|
|
89
|
-
type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
|
|
91
|
+
type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact' | 'free_trial' | 'pay_up_front' | 'pay_as_you_go'
|
|
90
92
|
type UnbilledChargesHandling = 'no_action' | 'invoice'
|
|
91
93
|
type UnbilledChargesOption = 'invoice' | 'delete'
|
|
92
94
|
type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection'
|
package/types/index.d.ts
CHANGED
|
@@ -46,10 +46,13 @@
|
|
|
46
46
|
///<reference path='./resources/ItemPrice.d.ts' />
|
|
47
47
|
///<reference path='./resources/Metadata.d.ts' />
|
|
48
48
|
///<reference path='./resources/NonSubscription.d.ts' />
|
|
49
|
+
///<reference path='./resources/OfferEvent.d.ts' />
|
|
50
|
+
///<reference path='./resources/OfferFulfillment.d.ts' />
|
|
49
51
|
///<reference path='./resources/OmnichannelOneTimeOrder.d.ts' />
|
|
50
52
|
///<reference path='./resources/OmnichannelOneTimeOrderItem.d.ts' />
|
|
51
53
|
///<reference path='./resources/OmnichannelSubscription.d.ts' />
|
|
52
54
|
///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
|
|
55
|
+
///<reference path='./resources/OmnichannelSubscriptionItemOffer.d.ts' />
|
|
53
56
|
///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
|
|
54
57
|
///<reference path='./resources/OmnichannelTransaction.d.ts' />
|
|
55
58
|
///<reference path='./resources/Order.d.ts' />
|
|
@@ -60,6 +63,7 @@
|
|
|
60
63
|
///<reference path='./resources/PaymentScheduleScheme.d.ts' />
|
|
61
64
|
///<reference path='./resources/PaymentSource.d.ts' />
|
|
62
65
|
///<reference path='./resources/PaymentVoucher.d.ts' />
|
|
66
|
+
///<reference path='./resources/PersonalizedOffer.d.ts' />
|
|
63
67
|
///<reference path='./resources/Plan.d.ts' />
|
|
64
68
|
///<reference path='./resources/PortalSession.d.ts' />
|
|
65
69
|
///<reference path='./resources/PriceVariant.d.ts' />
|
|
@@ -126,6 +130,8 @@ declare module 'chargebee' {
|
|
|
126
130
|
static item_family: ItemFamily.ItemFamilyResource;
|
|
127
131
|
static item_price: ItemPrice.ItemPriceResource;
|
|
128
132
|
static non_subscription: NonSubscription.NonSubscriptionResource;
|
|
133
|
+
static offer_event: OfferEvent.OfferEventResource;
|
|
134
|
+
static offer_fulfillment: OfferFulfillment.OfferFulfillmentResource;
|
|
129
135
|
static omnichannel_one_time_order: OmnichannelOneTimeOrder.OmnichannelOneTimeOrderResource;
|
|
130
136
|
static omnichannel_subscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
|
|
131
137
|
static omnichannel_subscription_item: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
|
|
@@ -134,6 +140,7 @@ declare module 'chargebee' {
|
|
|
134
140
|
static payment_schedule_scheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
|
|
135
141
|
static payment_source: PaymentSource.PaymentSourceResource;
|
|
136
142
|
static payment_voucher: PaymentVoucher.PaymentVoucherResource;
|
|
143
|
+
static personalized_offer: PersonalizedOffer.PersonalizedOfferResource;
|
|
137
144
|
static plan: Plan.PlanResource;
|
|
138
145
|
static portal_session: PortalSession.PortalSessionResource;
|
|
139
146
|
static price_variant: PriceVariant.PriceVariantResource;
|
|
@@ -69,7 +69,7 @@ declare module 'chargebee' {
|
|
|
69
69
|
|
|
70
70
|
offset?:string;
|
|
71
71
|
|
|
72
|
-
entity_type?:'customer' | 'subscription' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'coupon' | 'order' | 'business_entity' | '
|
|
72
|
+
entity_type?:'customer' | 'subscription' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'coupon' | 'order' | 'business_entity' | 'item_family' | 'item' | 'item_price' | 'price_variant';
|
|
73
73
|
|
|
74
74
|
entity_id?:string;
|
|
75
75
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
///<reference path='./../index.d.ts'/>
|
|
3
3
|
declare module 'chargebee' {
|
|
4
4
|
export interface CreditNote {
|
|
5
|
-
|
|
5
|
+
[key : string] : any;
|
|
6
6
|
|
|
7
7
|
id:string;
|
|
8
8
|
|
|
@@ -135,7 +135,7 @@ declare module 'chargebee' {
|
|
|
135
135
|
invoice?:Invoice;
|
|
136
136
|
}
|
|
137
137
|
export interface CreateInputParam {
|
|
138
|
-
|
|
138
|
+
[key : string] : any;
|
|
139
139
|
line_items?:{amount?:number,date_from?:number,date_to?:number,description?:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan' | 'addon',quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
140
140
|
|
|
141
141
|
reference_invoice_id?:string;
|
|
@@ -413,7 +413,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
413
413
|
credit_note:CreditNote;
|
|
414
414
|
}
|
|
415
415
|
export interface ImportCreditNoteInputParam {
|
|
416
|
-
|
|
416
|
+
[key : string] : any;
|
|
417
417
|
line_items:{amount?:number,amount_in_decimal?:string,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
418
418
|
|
|
419
419
|
line_item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,line_item_id:string,quantity_used?:number,quantity_used_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
@@ -686,8 +686,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
686
686
|
zip?:string;
|
|
687
687
|
|
|
688
688
|
validation_status?:ValidationStatus;
|
|
689
|
-
|
|
690
|
-
index:number;
|
|
691
689
|
}
|
|
692
690
|
export interface BillingAddress {
|
|
693
691
|
first_name?:string;
|
|
@@ -22,15 +22,15 @@ declare module 'chargebee' {
|
|
|
22
22
|
|
|
23
23
|
line_items?:CreditNoteEstimate.LineItem[];
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
line_item_tiers?:CreditNoteEstimate.LineItemTier[];
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
line_item_discounts?:CreditNoteEstimate.LineItemDiscount[];
|
|
28
28
|
|
|
29
29
|
line_item_taxes?:CreditNoteEstimate.LineItemTax[];
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
discounts?:CreditNoteEstimate.Discount[];
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
taxes?:CreditNoteEstimate.Tax[];
|
|
34
34
|
|
|
35
35
|
round_off_amount?:number;
|
|
36
36
|
|
|
@@ -91,25 +91,39 @@ declare module 'chargebee' {
|
|
|
91
91
|
|
|
92
92
|
customer_id?:string;
|
|
93
93
|
}
|
|
94
|
-
export interface
|
|
95
|
-
|
|
94
|
+
export interface LineItemTier {
|
|
95
|
+
line_item_id?:string;
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
starting_unit:number;
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
ending_unit?:number;
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
quantity_used:number;
|
|
102
102
|
|
|
103
|
-
|
|
103
|
+
unit_amount:number;
|
|
104
104
|
|
|
105
|
-
|
|
105
|
+
starting_unit_in_decimal?:string;
|
|
106
|
+
|
|
107
|
+
ending_unit_in_decimal?:string;
|
|
108
|
+
|
|
109
|
+
quantity_used_in_decimal?:string;
|
|
110
|
+
|
|
111
|
+
unit_amount_in_decimal?:string;
|
|
112
|
+
|
|
113
|
+
pricing_type?:'per_unit' | 'flat_fee' | 'package';
|
|
114
|
+
|
|
115
|
+
package_size?:number;
|
|
106
116
|
}
|
|
107
|
-
export interface
|
|
108
|
-
|
|
117
|
+
export interface LineItemDiscount {
|
|
118
|
+
line_item_id:string;
|
|
109
119
|
|
|
110
|
-
|
|
120
|
+
discount_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
111
121
|
|
|
112
|
-
|
|
122
|
+
coupon_id?:string;
|
|
123
|
+
|
|
124
|
+
entity_id?:string;
|
|
125
|
+
|
|
126
|
+
discount_amount:number;
|
|
113
127
|
}
|
|
114
128
|
export interface LineItemTax {
|
|
115
129
|
line_item_id?:string;
|
|
@@ -142,39 +156,25 @@ declare module 'chargebee' {
|
|
|
142
156
|
|
|
143
157
|
local_currency_code?:string;
|
|
144
158
|
}
|
|
145
|
-
export interface
|
|
146
|
-
|
|
159
|
+
export interface Discount {
|
|
160
|
+
amount:number;
|
|
147
161
|
|
|
148
|
-
|
|
162
|
+
description?:string;
|
|
149
163
|
|
|
150
|
-
|
|
164
|
+
entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
|
|
165
|
+
|
|
166
|
+
discount_type?:'fixed_amount' | 'percentage';
|
|
151
167
|
|
|
152
168
|
entity_id?:string;
|
|
153
169
|
|
|
154
|
-
|
|
170
|
+
coupon_set_code?:string;
|
|
155
171
|
}
|
|
156
|
-
export interface
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
starting_unit:number;
|
|
160
|
-
|
|
161
|
-
ending_unit?:number;
|
|
162
|
-
|
|
163
|
-
quantity_used:number;
|
|
164
|
-
|
|
165
|
-
unit_amount:number;
|
|
166
|
-
|
|
167
|
-
starting_unit_in_decimal?:string;
|
|
168
|
-
|
|
169
|
-
ending_unit_in_decimal?:string;
|
|
170
|
-
|
|
171
|
-
quantity_used_in_decimal?:string;
|
|
172
|
-
|
|
173
|
-
unit_amount_in_decimal?:string;
|
|
172
|
+
export interface Tax {
|
|
173
|
+
name:string;
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
amount:number;
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
description?:string;
|
|
178
178
|
}
|
|
179
179
|
}
|
|
180
180
|
}
|
|
@@ -4,22 +4,22 @@ declare module 'chargebee' {
|
|
|
4
4
|
export interface Currency {
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
id
|
|
7
|
+
id:string;
|
|
8
8
|
|
|
9
9
|
enabled:boolean;
|
|
10
10
|
|
|
11
11
|
forex_type?:'manual' | 'auto';
|
|
12
12
|
|
|
13
|
-
currency_code
|
|
13
|
+
currency_code:string;
|
|
14
14
|
|
|
15
|
-
is_base_currency
|
|
15
|
+
is_base_currency:boolean;
|
|
16
16
|
|
|
17
17
|
manual_exchange_rate?:string;
|
|
18
18
|
|
|
19
19
|
}
|
|
20
20
|
export namespace Currency {
|
|
21
21
|
export class CurrencyResource {
|
|
22
|
-
list():ChargebeeRequest<ListResponse>;
|
|
22
|
+
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
23
23
|
|
|
24
24
|
retrieve(site_currency_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
25
25
|
|
|
@@ -32,9 +32,26 @@ declare module 'chargebee' {
|
|
|
32
32
|
remove_schedule(site_currency_id:string):ChargebeeRequest<RemoveScheduleResponse>;
|
|
33
33
|
}
|
|
34
34
|
export interface ListResponse {
|
|
35
|
-
currency:Currency;
|
|
35
|
+
list:{currency:Currency}[];
|
|
36
|
+
|
|
37
|
+
next_offset?:string;
|
|
38
|
+
}
|
|
39
|
+
export interface ListInputParam {
|
|
40
|
+
[key : string]: any;
|
|
41
|
+
/**
|
|
42
|
+
* @description The number of resources to be returned.
|
|
43
|
+
|
|
44
|
+
*/
|
|
45
|
+
|
|
46
|
+
limit?:number;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
50
|
+
|
|
51
|
+
*/
|
|
52
|
+
|
|
53
|
+
offset?:string;
|
|
36
54
|
}
|
|
37
|
-
|
|
38
55
|
export interface RetrieveResponse {
|
|
39
56
|
currency:Currency;
|
|
40
57
|
}
|
|
@@ -107,7 +107,7 @@ declare module 'chargebee' {
|
|
|
107
107
|
}
|
|
108
108
|
export interface CreateSubItemEstimateInputParam {
|
|
109
109
|
|
|
110
|
-
subscription?:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
110
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
111
111
|
|
|
112
112
|
billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
113
113
|
|
|
@@ -177,7 +177,7 @@ declare module 'chargebee' {
|
|
|
177
177
|
}
|
|
178
178
|
export interface CreateSubItemForCustomerEstimateInputParam {
|
|
179
179
|
|
|
180
|
-
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
180
|
+
subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
|
|
181
181
|
|
|
182
182
|
shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
183
183
|
|
|
@@ -76,7 +76,7 @@ declare module 'chargebee' {
|
|
|
76
76
|
|
|
77
77
|
*/
|
|
78
78
|
|
|
79
|
-
event_type?:{in?:string,is?:'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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled',is_not?:'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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled',not_in?:string};
|
|
79
|
+
event_type?:{in?:string,is?:'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' | 'dunning_updated' | '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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled' | 'omnichannel_subscription_moved_in',is_not?:'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' | 'dunning_updated' | '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' | 'omnichannel_subscription_item_paused' | 'omnichannel_subscription_item_resumed' | 'omnichannel_one_time_order_created' | 'omnichannel_one_time_order_item_cancelled' | 'usage_file_ingested' | 'omnichannel_subscription_item_pause_scheduled' | 'omnichannel_subscription_moved_in',not_in?:string};
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
82
|
* @description Source of the event
|