chargebee 2.51.0 → 2.52.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.
Files changed (64) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/lib/chargebee.js +1 -1
  3. package/lib/resources/api_endpoints.js +14 -1
  4. package/package.json +1 -1
  5. package/types/core.d.ts +4 -4
  6. package/types/index.d.ts +2 -0
  7. package/types/resources/Address.d.ts +2 -194
  8. package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
  9. package/types/resources/Attribute.d.ts +4 -1
  10. package/types/resources/BillingConfiguration.d.ts +21 -0
  11. package/types/resources/Brand.d.ts +12 -0
  12. package/types/resources/BusinessEntity.d.ts +8 -6
  13. package/types/resources/BusinessEntityTransfer.d.ts +10 -7
  14. package/types/resources/Card.d.ts +11 -311
  15. package/types/resources/Comment.d.ts +7 -124
  16. package/types/resources/Contact.d.ts +2 -44
  17. package/types/resources/ContractTerm.d.ts +4 -72
  18. package/types/resources/Coupon.d.ts +0 -37
  19. package/types/resources/CouponCode.d.ts +67 -35
  20. package/types/resources/CouponSet.d.ts +12 -121
  21. package/types/resources/CreditNote.d.ts +0 -6
  22. package/types/resources/Currency.d.ts +8 -5
  23. package/types/resources/Customer.d.ts +90 -89
  24. package/types/resources/Discount.d.ts +2 -89
  25. package/types/resources/Download.d.ts +2 -14
  26. package/types/resources/Entitlement.d.ts +15 -103
  27. package/types/resources/EntitlementOverride.d.ts +4 -89
  28. package/types/resources/Estimate.d.ts +2 -10
  29. package/types/resources/Event.d.ts +23 -108
  30. package/types/resources/Export.d.ts +116 -432
  31. package/types/resources/Feature.d.ts +17 -319
  32. package/types/resources/GatewayErrorDetail.d.ts +6 -48
  33. package/types/resources/Gift.d.ts +34 -294
  34. package/types/resources/Hierarchy.d.ts +4 -24
  35. package/types/resources/ImpactedItem.d.ts +4 -36
  36. package/types/resources/ImpactedItemPrice.d.ts +5 -2
  37. package/types/resources/ImpactedSubscription.d.ts +3 -30
  38. package/types/resources/InAppSubscription.d.ts +13 -355
  39. package/types/resources/Invoice.d.ts +2 -16
  40. package/types/resources/InvoiceEstimate.d.ts +1 -1
  41. package/types/resources/Item.d.ts +0 -7
  42. package/types/resources/ItemEntitlement.d.ts +15 -155
  43. package/types/resources/NonSubscription.d.ts +9 -6
  44. package/types/resources/PaymentIntent.d.ts +9 -255
  45. package/types/resources/PaymentReferenceNumber.d.ts +3 -20
  46. package/types/resources/PaymentSource.d.ts +2 -2
  47. package/types/resources/PaymentVoucher.d.ts +20 -203
  48. package/types/resources/PortalSession.d.ts +4 -146
  49. package/types/resources/PromotionalCredit.d.ts +10 -215
  50. package/types/resources/Purchase.d.ts +3 -1
  51. package/types/resources/Quote.d.ts +19 -1
  52. package/types/resources/QuotedRamp.d.ts +11 -16
  53. package/types/resources/RecordedPurchase.d.ts +2 -0
  54. package/types/resources/ResourceMigration.d.ts +2 -54
  55. package/types/resources/SiteMigrationDetail.d.ts +13 -55
  56. package/types/resources/Subscription.d.ts +11 -9
  57. package/types/resources/SubscriptionEntitlement.d.ts +6 -106
  58. package/types/resources/SubscriptionEstimate.d.ts +14 -11
  59. package/types/resources/TaxWithheld.d.ts +14 -26
  60. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
  61. package/types/resources/TimeMachine.d.ts +3 -64
  62. package/types/resources/Token.d.ts +3 -60
  63. package/types/resources/Transaction.d.ts +2 -2
  64. package/types/resources/Usage.d.ts +21 -165
@@ -3,76 +3,21 @@
3
3
  declare module 'chargebee' {
4
4
  export interface EntitlementOverride {
5
5
 
6
- /**
7
- * @description Unique identifier for the entitlement override. This is always auto-generated.
8
6
 
9
- */
10
-
11
7
  id:string;
12
-
13
- /**
14
- * @description The `id` of the subscription to which this entitlement override belongs.
15
8
 
16
- */
17
-
18
9
  entity_id?:string;
19
-
20
- /**
21
- * @description The name of Chargebee resource that this entitlement override is associated with. The value is always `subscription`.
22
10
 
23
- */
24
-
25
11
  entity_type?:string;
26
-
27
- /**
28
- * @description The `id` of the `feature` towards which this entitlement override has been granted.
29
12
 
30
- */
31
-
32
13
  feature_id?:string;
33
-
34
- /**
35
- * @description The `name` of the `feature` towards which this entitlement override has been granted.
36
14
 
37
- */
38
-
39
15
  feature_name?:string;
40
-
41
- /**
42
- * @description The level of entitlement that the item has towards the feature. The possible values depend on the value of `feature.type`:
43
16
 
44
- * When `feature.type` is `quantity` and:
45
- * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.
46
- * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can also be:
47
- * any one of `feature.levels[value][]`
48
- * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
49
- * When `type` is `range` and:
50
- * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).
51
- * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:
52
- * any whole number equal to or greater than `levels[value][0]`
53
- * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
54
- * When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.
55
- * When `type` is `switch`, then the value is set as `true` if the feature is available; it is set as `false` when the feature is unavailable.
56
-
57
- */
58
-
59
17
  value?:string;
60
-
61
- /**
62
- * @description The display name for the entitlement level. The default values are auto-generated based on `feature.type` as follows:
63
18
 
64
- * When `feature.type` is `quantity` or `range`, then `name` is the space-separated concatenation of `value` and the pluralized version of `feature.unit`. For example, if `value` is `20` and `feature.unit` is `user`, then `name` becomes `20 users`.
65
- * When `feature.type` is `custom`, then `name` is the same as `value`
66
-
67
- */
68
-
69
19
  name?:string;
70
-
71
- /**
72
- * @description The expiry date for the `entitlement_override`. Once expired, the `entitlement_override` object is no longer returned.
73
20
 
74
- */
75
-
76
21
  expires_at?:number;
77
22
 
78
23
  effective_from?:number;
@@ -82,18 +27,8 @@ declare module 'chargebee' {
82
27
  }
83
28
  export namespace EntitlementOverride {
84
29
  export class EntitlementOverrideResource {
85
- /**
86
- * @description Upserts or removes a set of `entitlement_overrides` for a `subscription` depending on the `action` specified. The API returns the upserted or deleted `entitlement_overrides` after successfully completing the operation. The operation returns an error when the first `entitlement_override` fails to be processed. Either all the `entitlement_overrides` provided in the request are processed or none.
87
-
88
- */
89
-
90
- add_entitlement_override_for_subscription(subscription_id:string, input?:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
30
+ add_entitlement_override_for_subscription(subscription_id:string, input:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
91
31
 
92
- /**
93
- * @description Retrieve the list of entitlement overrides for a subscription.
94
-
95
- */
96
-
97
32
  list_entitlement_override_for_subscription(subscription_id:string, input?:ListEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<ListEntitlementOverrideForSubscriptionResponse>;
98
33
  }
99
34
  export interface AddEntitlementOverrideForSubscriptionResponse {
@@ -101,46 +36,26 @@ declare module 'chargebee' {
101
36
  }
102
37
  export interface AddEntitlementOverrideForSubscriptionInputParam {
103
38
 
104
- /**
105
- * @description The specific action to be performed for each &#x60;entitlement_override&#x60; specified. . \* remove - Deletes the &#x60;entitlement_override&#x60; for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, if it exists. \* upsert - If the &#x60;entitlement_override&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;{subscription_id}&#x60; combination, the &#x60;value&#x60; of the &#x60;entitlement_override&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;entitlement_override&#x60; is created.
106
-
107
- */
39
+ entitlement_overrides:{effective_from?:number,expires_at?:number,feature_id:string,value?:string}[];
108
40
 
109
41
  action?:Action;
110
-
111
- /**
112
- * @description Parameters for entitlement_overrides
113
-
114
- */
115
-
116
- entitlement_overrides?:{expires_at?:number,feature_id:string,value?:string}[];
117
42
  }
118
43
  export interface ListEntitlementOverrideForSubscriptionResponse {
119
- /**
120
- * @description Retrieve the list of entitlement overrides for a subscription.
121
-
122
- */
123
-
124
44
  list:{entitlement_override:EntitlementOverride}[];
125
45
 
126
- /**
127
- * @description Retrieve the list of entitlement overrides for a subscription.
128
-
129
- */
130
-
131
46
  next_offset?:string;
132
47
  }
133
48
  export interface ListEntitlementOverrideForSubscriptionInputParam {
134
49
  [key : string]: any;
135
50
  /**
136
- * @description Retrieve the list of entitlement overrides for a subscription.
51
+ * @description The number of resources to be returned.
137
52
 
138
53
  */
139
54
 
140
55
  limit?:number;
141
56
 
142
57
  /**
143
- * @description Retrieve the list of entitlement overrides for a subscription.
58
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
144
59
 
145
60
  */
146
61
 
@@ -166,19 +166,11 @@ declare module 'chargebee' {
166
166
 
167
167
  terms_to_charge?:number;
168
168
 
169
- next_renewal_date?:number;
170
-
171
- charge_model?:'full_charge' | 'prorate';
172
-
173
169
  billing_alignment_mode?:'immediate' | 'delayed';
174
170
 
175
- referral_details?:string;
176
-
177
171
  invoice_date?:number;
178
172
 
179
173
  coupon_ids?:string[];
180
-
181
- allow_gift_plan?:boolean;
182
174
  }
183
175
  export interface CreateSubItemForCustomerEstimateResponse {
184
176
  estimate:Estimate;
@@ -472,7 +464,7 @@ declare module 'chargebee' {
472
464
 
473
465
  gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
474
466
 
475
- payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
467
+ payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
476
468
 
477
469
  shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
478
470
 
@@ -493,7 +485,7 @@ declare module 'chargebee' {
493
485
 
494
486
  gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
495
487
 
496
- payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
488
+ payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
497
489
 
498
490
  shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
499
491
 
@@ -1,170 +1,97 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface Event {
4
5
 
5
- /**
6
- * @description Uniquely identifies a event
7
6
 
8
- */
9
-
10
7
  id:string;
11
-
12
- /**
13
- * @description Timestamp indicating when this event had occurred.
14
8
 
15
- */
16
-
17
9
  occurred_at:number;
18
-
19
- /**
20
- * @description Source of the event \* admin_console - Operation made through the Chargebee admin UI \* external_service - Operation that are triggered via webhook \* scheduled_job - Operation made through the Scheduled Jobs \* bulk_operation - Operation that are triggerd through bulk operation. \* hosted_page - Operation made through the Hosted Pages \* portal - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html) \* system - Operation that are triggered by ChargeBee System \* migration - Deprecated \* none - If no source can be identified for an operation \* api - Operation made through the API \* js_api - Operation made through the JS API
21
10
 
22
- */
23
-
24
11
  source:Source;
25
-
26
- /**
27
- * @description The &quot;user&quot; that triggered the event. The value depends on the &#x60;source&#x60; attribute:
28
12
 
29
- * When &#x60;source&#x60; is &#x60;admin_console&#x60;: the email address of the user that triggered the event.
30
- * When &#x60;source&#x60; is &#x60;api&#x60;, &#x60;js_api&#x60; or &#x60;bulk_operation&#x60;: the [name](https://www.chargebee.com/docs/api_keys.html#create-an-api-key) of the API key that was used to trigger the event.
31
- * When the &#x60;source&#x60; is &#x60;external_service&#x60;: the name of the service that called our webhook. Eg. &#x60;ADYEN&#x60;, &#x60;STRIPE&#x60;, &#x60;AMAZON_PAYMENTS&#x60; etc.
32
- * When the &#x60;source&#x60; is &#x60;hosted_page&#x60; or &#x60;portal&#x60;: the &#x60;user&#x60; attribute is not passed.
33
-
34
- */
35
-
36
13
  user?:string;
37
-
38
- /**
39
- * @description The types of event provided by chargebee. Refer [event types](#event_types) for all the event types provided by us currently. \* card_deleted - Sent when a card is deleted for a customer \* subscription_cancelled - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;. \* customer_changed - Sent when a customer is changed \* invoice_deleted - Event triggered when an invoice is deleted. \* subscription_shipping_address_updated - Triggered when shipping address is added or updated for a subscription. \* differential_price_created - Triggered when a differential price is created \* subscription_created - Sent when a new subscription is created. \* payment_initiated - Sent when a payment is initiated via direct debit \* quote_updated - Triggered when quote is updated \* payment_source_added - Sent when a payment source is added for a customer. \* contract_term_created - Triggered when new contract term is created \* subscription_deleted - Sent when a subscription has been deleted \* differential_price_deleted - Triggered when a differential price is deleted \* voucher_created - Triggered when a payment voucher is created \* transaction_deleted - Triggered when a transaction is deleted. \* item_family_deleted - Triggered when an item family is deleted \* product_updated - Triggered when the product update is completed successfully \* payment_failed - Sent when attempt to charge customer&#x27;s credit card fails \* subscription_reactivated_with_backdating - Sent when the subscription is moved from cancelled state to active or in_trial state with past date \* payment_source_expiring - Sent when the customer&#x27;s payment source is expiring soon. Sent 30 days before the expiry date. \* item_price_updated - Triggered when an item price is updated \* order_ready_to_process - Triggered when order reaches it&#x27;s order date \* entitlement_overrides_updated - Triggered when an override entitlement is updated \* item_updated - Triggered when an item is updated \* coupon_set_updated - Sent when a coupon set is changed \* subscription_reactivated - Sent when the subscription is moved from cancelled state to active or in_trial state \* variant_created - Triggered when product variant create completed successfully \* addon_updated - Sent when a addon is changed. \* subscription_scheduled_changes_removed - Sent when scheduled change for the subscription is removed. \* payment_refunded - Sent when a payment refund is made \* subscription_started - Sent when a &#x27;future&#x27; subscription gets started at the scheduled date. \* attached_item_created - Triggered when an Attached item is created \* token_created - Sent when a Token is created \* item_family_created - Triggered when an item family is created \* subscription_created_with_backdating - Sent when a new subscription is created with backdating. \* unbilled_charges_deleted - Triggered when unbilled charges are deleted \* promotional_credits_added - Sent when a customer prmotion credits added \* subscription_canceled_with_backdating - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as &#x27;cancel_reason&#x27;. \* item_entitlements_updated - Triggered when item entitlements are updated to a feature \* card_expired - Sent when a card for a customer is expired \* payment_intent_created - Sent when a Payment intent is created \* subscription_changed_with_backdating - Sent after the subscription&#x27;s recurring items have been changed with backdated date \* subscription_scheduled_cancellation_removed - Sent when scheduled cancellation is removed for the subscription. \* feature_updated - Triggered when an feature is updated \* plan_deleted - Sent when a plan is deleted. \* tax_withheld_refunded - Sent when a tax withheld refund is made \* unbilled_charges_voided - Triggered when unbilled charges are voided \* customer_moved_out - Sent when a customer is copied to another site \* feature_created - Triggered when a feature is created. \* coupon_codes_deleted - Sent when coupon codes are deleted in coupon set \* subscription_paused - Sent when the subscription is paused. \* order_updated - Triggered when order is updated \* unbilled_charges_created - Triggered when unbilled charges are created \* feature_archived - Triggered when an feature is archived \* payment_succeeded - Sent when the payment is successfully collected \* voucher_expired - Triggered when a payment voucher is expired \* mrr_updated - Sent when either of MRR or CMRR of a subscription changes \* subscription_scheduled_resumption_removed - Triggered when scheduled resumption is removed for the subscription. \* subscription_changes_scheduled - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term. \* order_ready_to_ship - Triggered when order reaches it&#x27;s shipping date \* purchase_created - Triggered when purchase action completed successfully \* variant_updated - Triggered when product variant update completed successfully \* variant_deleted - Triggered when product variant delete completed successfully \* subscription_trial_end_reminder - Sent when the customer&#x27;s trial period is about to end. \* feature_activated - Triggered when a feature \&#x60;status\&#x60; transitions to \&#x60;active\&#x60; for the first time. \* subscription_renewed - Sent when the subscription is renewed from the current term. \* plan_created - Sent when a plan is created. \* item_created - Triggered when an item is created \* coupon_codes_updated - Sent when coupon codes are updated \* gift_unclaimed - Triggered when a new gift is unclaimed and is ready to be claimed \* subscription_entitlements_created - Triggered when subscription entitlements are created for a new subscription \* virtual_bank_account_added - Sent when a virtual bank account is added for a customer. \* contract_term_completed - Triggered when contract term is completed \* feature_deleted - Triggered when a feature is deleted \* subscription_renewal_reminder - Sent before each subscription&#x27;s renewal based on plan&#x27;s period \* coupon_updated - Sent when a coupon is changed. \* token_consumed - Sent when a Token is consumed \* transaction_created - Triggered when a transaction is recorded \* customer_deleted - Sent when a customer is deleted \* coupon_deleted - Sent when a coupon is deleted. \* quote_deleted - Triggered when quote is deleted \* card_updated - Sent when the card is updated for a customer. \* coupon_created - Sent when a coupon is created. \* quote_created - Triggered when quote is created \* add_usages_reminder - Sent every month day before renewal date of plan&#x27;s period \* business_entity_updated - Sent when a business entity is updated. \* subscription_changed - Sent after the subscription&#x27;s recurring items have been changed \* customer_created - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation. \* coupon_set_deleted - Sent when a coupon set is deleted \* refund_initiated - Sent when a refund is initiated via direct debit \* order_cancelled - Triggered when order is cancelled \* entitlement_overrides_removed - Triggered when an override entitlement is removed \* coupon_codes_added - Sent when coupon codes are added in coupon set \* card_added - Sent when a card is added for a customer. \* gift_cancelled - Triggered when a gift is cancelled. \* entitlement_overrides_auto_removed - Triggered when Subscription entitlements overrides for a feature are auto removed after expiry \* payment_source_deleted - Sent when a payment source is deleted for a customer \* credit_note_created - Sent when a credit note is created \* subscription_resumption_scheduled - Triggered when the subscription resumption is scheduled. \* item_price_deleted - Triggered when an item price is deleted \* subscription_advance_invoice_schedule_updated - Triggered when scheduled advance invoice is updated for a subscription. \* item_deleted - Triggered when an item is deleted \* gift_claimed - Triggered when a gift is claimed \* feature_reactivated - Triggered when a feature \&#x60;status\&#x60; transitions to \&#x60;active\&#x60; for the second time or more. \* subscription_activated - Sent after the subscription has been moved from trial to active state \* subscription_resumed - Sent when the subscription is moved from paused state to active state \* credit_note_deleted - Sent when a credit note is deleted \* subscription_advance_invoice_schedule_added - Triggered when advance invoice is scheduled for a subscription. \* differential_price_updated - Triggered when a differential price is updated \* order_deleted - Triggered when order is deleted \* token_expired - Sent when a Token is expired \* transaction_updated - Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated. \* subscription_cancellation_reminder - Sent when the customer&#x27;s subscription is nearing it&#x27;s scheduled cancellation date. \* product_deleted - Triggered when the product delete is completed successfully \* invoice_generated - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a &quot;Pending&quot; invoice is closed. \* order_delivered - Triggered when order is marked as delivered \* pending_invoice_created - Event triggered (in the case of metered billing) when a &quot;Pending&quot; invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the &quot;Notify for Pending Invoices&quot; option is enabled. \* authorization_succeeded - Triggered when a authorization transaction is created. \* invoice_generated_with_backdating - Event triggered when a new invoice is generated with past date as invoice date. \* subscription_cancellation_scheduled - Sent when subscription is scheduled to cancel at end of current term \* order_created - Triggered when order is created \* hierarchy_deleted - Triggered when a hierarchy is deleted \* subscription_activated_with_backdating - Sent after the subscription changes to \&#x60;active\&#x60; from another \&#x60;status\&#x60;, while the change is backdated. \* plan_updated - Sent when a plan is changed. \* tax_withheld_recorded - Triggered when a tax withheld is recorded for an invoice \* credit_note_created_with_backdating - Sent when a credit note is created with past date as credit note date \* gift_updated - Triggered when a gift is updated \* order_resent - Triggered when order is resent \* hierarchy_created - Triggered when a hierarchy is created \* addon_deleted - Sent when a addon is deleted. \* voucher_create_failed - Triggered when a payment voucher creation is failed \* customer_moved_in - Sent when a customer is copied from another site \* attached_item_deleted - Triggered when an Attached item is deleted \* unbilled_charges_invoiced - Triggered when unbilled charges are invoiced \* subscription_pause_scheduled - Sent when the subscription is scheduled to pause. \* order_returned - Triggered when order is marked as returned \* payment_source_expired - Sent when a payment source for a customer is expired \* contract_term_terminated - Triggered when contract term is terminated \* product_created - Triggered when the product create is completed successfully \* payment_source_updated - Sent when the payment source is updated for a customer or when role is assigned to the payment source. \* pending_invoice_updated - Event triggered when the option &quot;Notify and wait to close invoices&quot; is enabled, and the &#x27;Pending&#x27; invoice is updated. \* subscription_advance_invoice_schedule_removed - Triggered when scheduled advance invoice is removed for a subscription. \* tax_withheld_deleted - Triggered when a tax withheld is deleted \* business_entity_created - Sent when a business entity is created. \* item_price_created - Triggered when an item price is created \* virtual_bank_account_updated - Sent when the virtual bank account is updated for a customer. \* credit_note_updated - Sent when a credit note is updated \* subscription_scheduled_pause_removed - Triggered when scheduled pause is removed for the subscription. \* card_expiry_reminder - Sent when the customer&#x27;s credit card is expiring soon. Sent 30 days before the expiry date. \* coupon_set_created - Sent when a coupon set is created \* virtual_bank_account_deleted - Sent when a virtual bank account is deleted for a customer. \* gift_scheduled - Triggered when a new gift is created \* business_entity_deleted - Sent when a business entity is deleted. \* promotional_credits_deducted - Sent when a customer prmotion credits deducted \* contract_term_renewed - Triggered when new contract term is renewed \* subscription_trial_extended - Trial Extension \* item_entitlements_removed - Triggered when item entitlements are removed for a feature \* gift_expired - Triggered when a gift expires \* contract_term_cancelled - Triggered when contract term is cancelled \* authorization_voided - Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time. \* item_family_updated - Triggered when an item family is updated \* addon_created - Sent when a addon is created. \* attached_item_updated - Triggered when an Attached item is updated \* invoice_updated - Triggered when the invoice&#x27;s shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed. \* payment_intent_updated - Sent when a Payment intent is updated \* payment_source_locally_deleted - Sent when a payment source for a customer removed from Chargebee
40
14
 
41
- */
42
-
15
+ webhook_status:'not_configured' | 'scheduled' | 'succeeded' | 're_scheduled' | 'failed' | 'skipped' | 'not_applicable' | 'disabled';
16
+
17
+ webhook_failure_reason?:string;
18
+
19
+ webhooks?:Event.Webhook[];
20
+
43
21
  event_type?:EventType;
44
-
45
- /**
46
- * @description The Chargebee API Version used for rendering this event content. While processing webhooks, ensure this version is same as the API version used by your webhook server&#x27;s client library. \* v1 - Chargebee API version V1 \* v2 - Chargebee API version V2
47
22
 
48
- */
49
-
50
23
  api_version?:ApiVersion;
51
-
52
- /**
53
- * @description The JSON data associated with this event. Has resources (*subscription* , *invoice* etc) based on the [event type](#event_types). These resources are structured based on the Chargebee API version indicated by the *api_version* attribute.
54
24
 
55
- */
56
-
57
- content:object;
58
-
59
25
  origin_user?:string;
60
-
61
- /**
62
- * @description Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the &#x60;webhook&#x60; object data is a queued operation and hence there can be an additional delay of up to 5 seconds.
63
26
 
64
- */
65
-
66
- webhooks?:Event.Webhook[];
67
27
  }
68
28
  export namespace Event {
69
29
  export class EventResource {
70
- /**
71
- * @description Retrieves list of events.
72
-
73
-
74
- */
75
-
76
30
  list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
77
31
 
78
- /**
79
- * @description Retrieves a specific event identified by a unique event identifier.
80
-
81
- **Note:** Only events that are less than 90 days old will be retrieved.
82
-
83
- */
84
-
85
32
  retrieve(event_id:string):ChargebeeRequest<RetrieveResponse>;
86
33
  }
87
34
  export interface ListResponse {
88
- /**
89
- * @description Retrieves list of events.
90
-
91
-
92
- */
93
-
94
35
  list:{event:Event}[];
95
36
 
96
- /**
97
- * @description Retrieves list of events.
98
-
99
-
100
- */
101
-
102
37
  next_offset?:string;
103
38
  }
104
39
  export interface ListInputParam {
105
40
  [key : string]: any;
106
41
  /**
107
- * @description Retrieves list of events.
108
-
42
+ * @description The number of resources to be returned.
109
43
 
110
44
  */
111
45
 
112
46
  limit?:number;
113
47
 
114
48
  /**
115
- * @description Retrieves list of events.
116
-
49
+ * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
117
50
 
118
51
  */
119
52
 
120
53
  offset?:string;
121
54
 
55
+ start_time?:number;
56
+
57
+ end_time?:number;
58
+
122
59
  /**
123
- * @description Retrieves list of events.
124
-
60
+ * @description Uniquely identifies a event
125
61
 
126
62
  */
127
63
 
128
64
  id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
129
65
 
130
66
  /**
131
- * @description Retrieves list of events.
132
-
67
+ * @description Returns the events (occurred in the past 6 days) which has this status in any of the events&#x27; webhooks.
68
+ **Note**: To retrieve events which have occurred before the 6 day period, use the occurred_at(start_time/end_time) attribute.
133
69
 
134
70
  */
135
71
 
136
- webhook_status?:{in?:string,is?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped' | 'disabled',is_not?:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped',not_in?:string};
72
+ webhook_status?:{in?:string,is?:'not_configured' | 'scheduled' | 'succeeded' | 're_scheduled' | 'failed' | 'skipped' | 'not_applicable' | 'disabled',is_not?:'not_configured' | 'scheduled' | 'succeeded' | 're_scheduled' | 'failed' | 'skipped' | 'not_applicable' | 'disabled',not_in?:string};
137
73
 
138
74
  /**
139
- * @description Retrieves list of events.
140
-
75
+ * @description Specify it if you need to fetch events of a particular type.
141
76
 
142
77
  */
143
78
 
144
- event_type?:{in?:string,is?:'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided',is_not?:'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'plan_updated' ,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' | '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',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',not_in?:string};
145
80
 
146
81
  /**
147
- * @description Retrieves list of events.
148
-
82
+ * @description Source of the event
149
83
 
150
84
  */
151
85
 
152
- source?:{in?:string,is?:'admin_console' | 'system' | 'scheduled_job' | 'js_api' | 'bulk_operation' | 'hosted_page' | 'migration' | 'api' | 'none' | 'portal' | 'external_service',is_not?:'admin_console' | 'system' | 'scheduled_job' | 'js_api' | 'bulk_operation' | 'hosted_page' | 'migration' | 'api' | 'none' | 'portal' | 'external_service',not_in?:string};
86
+ source?:{in?:string,is?:'admin_console' | 'api' | 'scheduled_job' | 'hosted_page' | 'portal' | 'system' | 'none' | 'js_api' | 'migration' | 'bulk_operation' | 'external_service',is_not?:'admin_console' | 'api' | 'scheduled_job' | 'hosted_page' | 'portal' | 'system' | 'none' | 'js_api' | 'migration' | 'bulk_operation' | 'external_service',not_in?:string};
153
87
 
154
88
  /**
155
- * @description Retrieves list of events.
156
-
89
+ * @description Timestamp indicating when this event had occurred.
157
90
 
158
91
  */
159
92
 
160
93
  occurred_at?:{after?:string,before?:string,between?:string,on?:string};
161
94
 
162
- /**
163
- * @description Retrieves list of events.
164
-
165
-
166
- */
167
-
168
95
  sort_by?:{asc?:'occurred_at',desc?:'occurred_at'};
169
96
  }
170
97
  export interface RetrieveResponse {
@@ -172,21 +99,9 @@ declare module 'chargebee' {
172
99
  }
173
100
 
174
101
  export interface Webhook {
175
- /**
176
- * @description Uniquely identifies a webhook
177
-
178
- */
179
-
180
102
  id:string;
181
103
 
182
- /**
183
- * @description * **When the event resource is retrieved via API:** Represents the status of the webhook call made to this webhook.
184
- * **When the event resource is passed as part of a webhook call:** The &#x60;webhooks&#x60; object is unavailable on the first webhook call for the event. For subsequent calls, this attribute holds the status from after the last retry.
185
- \* failed - Webhook call has been suspended after the all retries have resulted in failure. \* succeeded - Webhook call was successful. \* scheduled - Webhook call has been scheduled. \* re_scheduled - Webhook call has been rescheduled due failure(s) in previous call(s) \* not_applicable - Webhook call is not applicable for this event. \* skipped - Skipped as specified in request \* not_configured - Webhook was not configured when this event occurred
186
-
187
- */
188
-
189
- webhook_status:'not_configured' | 're_scheduled' | 'scheduled' | 'failed' | 'not_applicable' | 'succeeded' | 'skipped' | 'disabled';
104
+ webhook_status:'not_configured' | 'scheduled' | 'succeeded' | 're_scheduled' | 'failed' | 'skipped' | 'not_applicable' | 'disabled';
190
105
  }
191
106
  }
192
107
  }