chargebee 2.49.1 → 2.51.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 CHANGED
@@ -1,3 +1,102 @@
1
+ ### v2.51.0 (2025-06-19)
2
+ * * *
3
+
4
+ ### New Resources
5
+ * QuotedRamp has been added.
6
+
7
+ ### New Attributes
8
+ * chargebee_response_schema_type has been added to Configuration.
9
+ * linked_item has been added to OmnichannelSubscriptionItem.
10
+ * resumes_at has been added to OmnichannelSubscriptionItem.
11
+
12
+ ### Changed Attributes
13
+ * percentage changed to is_percentage_pricing in CreditNote.
14
+ * percentage changed to is_percentage_pricing in QuoteLineGroup.
15
+ * percentage changed to is_percentage_pricing in CreditNoteEstimate.
16
+ * percentage changed to is_percentage_pricing in Invoice.
17
+ * percentage changed to is_percentage_pricing in InvoiceEstimate.
18
+ * percentage changed to is_percentage_pricing in Quote.
19
+
20
+
21
+ ### New Input Parameters
22
+ * is_percentage_pricing has been added to Item#UpdateRequest.
23
+ * line_item[subscription_id] has been added to CreditNote#RetrieveRequest.
24
+ * line_item[customer_id] has been added to CreditNote#RetrieveRequest.
25
+ * line_item[subscription_id] has been added to Invoice#RetrieveRequest.
26
+ * line_item[customer_id] has been added to Invoice#RetrieveRequest.
27
+ * billing_override[max_excess_payment_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
28
+ * billing_override[max_refundable_credits_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
29
+ * billing_override[max_excess_payment_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
30
+ * billing_override[max_refundable_credits_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
31
+ * billing_start_option has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
32
+ * net_term_days has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
33
+ * billing_address has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
34
+ * subscription_items has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
35
+ * discounts has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
36
+ * billing_start_option has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
37
+ * net_term_days has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
38
+ * billing_address has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
39
+ * subscription_items has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
40
+ * discounts has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
41
+ * net_term_days has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
42
+ * subscription_items has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
43
+ * discount has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
44
+ * coupons has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
45
+ * net_term_days has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
46
+ * subscription_items has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
47
+ * discounts has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
48
+ * coupons has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
49
+ * billing_address has been added to Quote#CreateForChargeItemsAndChargesRequest.
50
+ * billing_address has been added to Quote#EditForChargeItemsAndChargesRequest.
51
+ * sort_by[order] has been added to Subscription#SubscriptionContractTermsForSubscriptionRequest.
52
+ * item_tiers has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
53
+ * item_tiers has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
54
+ * item_tiers has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
55
+ * item_tiers has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
56
+
57
+ ### New Endpoints:
58
+ * PauseDunningRequest has been added to Invoice.
59
+ * ResumeDunningRequest has been added to Invoice.
60
+
61
+ ### Enum Attributes:
62
+ * BillingPeriodUnitEnum has been added.
63
+ * BillingStartOptionEnum has been added.
64
+ * OMNICHANNEL_SUBSCRIPTION_ITEM_RESUMED has been added to EventTypeEnum.
65
+
66
+ ### v2.50.0 (2025-05-15)
67
+ * * *
68
+
69
+ ### New Resources
70
+ * UsageFile has been added.
71
+
72
+ ### Input Parameter
73
+ * discount[apply_on] has been made optional from required in Estimate#CreateSubItemEstimateRequest.
74
+ * discount[apply_on] has been made optional from required in Estimate#CreateSubItemForCustomerEstimateRequest.
75
+ * discount[apply_on] has been made optional from required in Estimate#UpdateSubscriptionForItemsRequest.
76
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
77
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
78
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
79
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
80
+ * discount[apply_on] has been made optional from required in PricingPageSession#CheckoutNewForItemsRequest.
81
+ * discount[apply_on] has been made optional from required in PricingPageSession#CreateForExistingSubscriptionRequest.
82
+ * discount[apply_on] has been made optional from required in Quote#CreateSubItemsForCustomerQuoteRequest.
83
+ * discount[apply_on] has been made optional from required in Quote#EditCreateSubCustomerQuoteForItemsRequest.
84
+ * discount[apply_on] has been made optional from required in Quote#UpdateSubscriptionQuoteForItemsRequest.
85
+ * discount[apply_on] has been made optional from required in Quote#EditUpdateSubscriptionQuoteForItemsRequest.
86
+ * discount[apply_on] has been made optional from required in Subscription#CreateWithItemsRequest.
87
+ * discount[apply_on] has been made optional from required in Subscription#UpdateForItemsRequest.
88
+ * discount[apply_on] has been made optional from required in Subscription#ImportForItemsRequest.
89
+ * line_item_addresses[] has been added to Invoice#ImportInvoiceRequest.
90
+ * source has been added to OmnichannelSubscription#OmnichannelSubscriptionListRequest.
91
+
92
+ ### Attributes:
93
+ * swift_code has been made optional from required in VirtualBankAccount.
94
+
95
+ ### Enum Attributes:
96
+ * OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSED has been added to EventTypeEnum.
97
+ * PAUSED has been added to OmnichannelSubscriptionItem#StatusEnum.
98
+ * MERCHANT_REVOKED has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
99
+
1
100
  ### v2.49.1 (2025-04-25)
2
101
  * * *
3
102
 
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.49.1',
14
+ clientVersion: 'v2.51.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -1159,6 +1159,28 @@ var _endpoints = {
1159
1159
  {
1160
1160
  }
1161
1161
  ],
1162
+ [
1163
+ "pause_dunning",
1164
+ "POST",
1165
+ "/invoices",
1166
+ "/pause_dunning",
1167
+ true,
1168
+ null,
1169
+ false,
1170
+ {
1171
+ }
1172
+ ],
1173
+ [
1174
+ "resume_dunning",
1175
+ "POST",
1176
+ "/invoices",
1177
+ "/resume_dunning",
1178
+ true,
1179
+ null,
1180
+ false,
1181
+ {
1182
+ }
1183
+ ],
1162
1184
  [
1163
1185
  "import_invoice",
1164
1186
  "POST",
@@ -2772,6 +2794,7 @@ var _endpoints = {
2772
2794
  ],
2773
2795
  "quoted_subscription": [],
2774
2796
  "quoted_charge": [],
2797
+ "quoted_ramp": [],
2775
2798
  "quote_line_group": [],
2776
2799
  "plan": [
2777
2800
  [
@@ -4731,6 +4754,30 @@ var _endpoints = {
4731
4754
  }
4732
4755
  ]
4733
4756
  ],
4734
- "omnichannel_subscription_item_scheduled_change": []
4757
+ "omnichannel_subscription_item_scheduled_change": [],
4758
+ "usage_file": [
4759
+ [
4760
+ "upload",
4761
+ "POST",
4762
+ "/usage_files",
4763
+ "/upload",
4764
+ false,
4765
+ "file-ingest",
4766
+ false,
4767
+ {
4768
+ }
4769
+ ],
4770
+ [
4771
+ "status",
4772
+ "GET",
4773
+ "/usage_files",
4774
+ "/status",
4775
+ true,
4776
+ "file-ingest",
4777
+ false,
4778
+ {
4779
+ }
4780
+ ]
4781
+ ]
4735
4782
  };
4736
4783
  module.exports = _endpoints;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name":"chargebee",
3
- "version":"2.49.1",
3
+ "version":"2.51.0",
4
4
  "description":"A library for integrating with ChargeBee.",
5
5
  "keywords":[
6
6
  "payments",
package/types/core.d.ts CHANGED
@@ -22,12 +22,15 @@ declare module 'chargebee' {
22
22
  type BillingAlignmentMode = 'immediate' | 'delayed'
23
23
  type BillingDateMode = 'using_defaults' | 'manually_set'
24
24
  type BillingDayOfWeekMode = 'using_defaults' | 'manually_set'
25
+ type BillingPeriodUnit = 'day' | 'week' | 'month' | 'year'
26
+ type BillingStartOption = 'immediately' | 'on_specific_date'
25
27
  type CancelOption = 'immediately' | 'end_of_term' | 'specific_date' | 'end_of_billing_term'
26
28
  type ChangeOption = 'immediately' | 'end_of_term' | 'specific_date'
27
29
  type Channel = 'web' | 'app_store' | 'play_store'
28
30
  type ChargeModel = 'full_charge' | 'prorate'
29
31
  type ChargeOnEvent = 'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination' | 'on_demand'
30
32
  type ChargeOnOption = 'immediately' | 'on_event'
33
+ type ChargebeeResponseSchemaType = 'plans_addons' | 'items' | 'compat'
31
34
  type ChargesHandling = 'invoice_immediately' | 'add_to_unbilled_charges'
32
35
  type ContractTermCancelOption = 'terminate_immediately' | 'end_of_contract_term' | 'specific_date' | 'end_of_subscription_billing_term'
33
36
  type CreditOptionForCurrentTermCharges = 'none' | 'prorate' | 'full'
@@ -44,7 +47,7 @@ declare module 'chargebee' {
44
47
  type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
45
48
  type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order'
46
49
  type EventName = 'cancellation_page_loaded'
47
- type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | 'omnichannel_subscription_item_downgraded' | 'omnichannel_subscription_item_expired' | 'omnichannel_subscription_item_cancellation_scheduled' | 'omnichannel_subscription_item_scheduled_cancellation_removed' | 'omnichannel_subscription_item_resubscribed' | 'omnichannel_subscription_item_upgraded' | 'omnichannel_subscription_item_cancelled' | 'omnichannel_subscription_imported' | 'omnichannel_subscription_item_grace_period_started' | 'omnichannel_subscription_item_grace_period_expired' | 'omnichannel_subscription_item_dunning_started' | 'omnichannel_subscription_item_dunning_expired' | 'rule_created' | 'rule_updated' | 'rule_deleted' | 'record_purchase_failed' | 'omnichannel_subscription_item_change_scheduled' | 'omnichannel_subscription_item_scheduled_change_removed' | 'omnichannel_subscription_item_reactivated' | 'sales_order_created' | 'sales_order_updated' | 'omnichannel_subscription_item_changed' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
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' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
48
51
  type ExportType = 'data' | 'import_friendly_data'
49
52
  type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
50
53
  type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
package/types/index.d.ts CHANGED
@@ -64,6 +64,7 @@
64
64
  ///<reference path='./resources/Quote.d.ts' />
65
65
  ///<reference path='./resources/QuoteLineGroup.d.ts' />
66
66
  ///<reference path='./resources/QuotedCharge.d.ts' />
67
+ ///<reference path='./resources/QuotedRamp.d.ts' />
67
68
  ///<reference path='./resources/QuotedSubscription.d.ts' />
68
69
  ///<reference path='./resources/Ramp.d.ts' />
69
70
  ///<reference path='./resources/RecordedPurchase.d.ts' />
@@ -81,6 +82,7 @@
81
82
  ///<reference path='./resources/UnbilledCharge.d.ts' />
82
83
  ///<reference path='./resources/Usage.d.ts' />
83
84
  ///<reference path='./resources/UsageEvent.d.ts' />
85
+ ///<reference path='./resources/UsageFile.d.ts' />
84
86
  ///<reference path='./resources/VirtualBankAccount.d.ts' />
85
87
 
86
88
  declare module 'chargebee' {
@@ -142,6 +144,7 @@ declare module 'chargebee' {
142
144
  static unbilled_charge: UnbilledCharge.UnbilledChargeResource;
143
145
  static usage: Usage.UsageResource;
144
146
  static usage_event: UsageEvent.UsageEventResource;
147
+ static usage_file: UsageFile.UsageFileResource;
145
148
  static virtual_bank_account: VirtualBankAccount.VirtualBankAccountResource;
146
149
 
147
150
  }
@@ -8,6 +8,8 @@ declare module 'chargebee' {
8
8
 
9
9
  product_catalog_version?:ProductCatalogVersion;
10
10
 
11
+ chargebee_response_schema_type?:ChargebeeResponseSchemaType;
12
+
11
13
  }
12
14
  export namespace Configuration {
13
15
  export class ConfigurationResource {
@@ -163,6 +163,8 @@ declare module 'chargebee' {
163
163
  }
164
164
  export interface RetrieveInputParam {
165
165
 
166
+ line_item?:{customer_id?:{is?:string},subscription_id?:{is?:string}};
167
+
166
168
  line_items_limit?:number;
167
169
 
168
170
  line_items_offset?:string;
@@ -506,7 +508,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
506
508
 
507
509
  metered?:boolean;
508
510
 
509
- percentage?:string;
511
+ is_percentage_pricing?:boolean;
510
512
 
511
513
  reference_line_item_id?:string;
512
514
 
@@ -75,7 +75,7 @@ declare module 'chargebee' {
75
75
 
76
76
  metered?:boolean;
77
77
 
78
- percentage?:string;
78
+ is_percentage_pricing?:boolean;
79
79
 
80
80
  reference_line_item_id?:string;
81
81
 
@@ -119,7 +119,7 @@ declare module 'chargebee' {
119
119
 
120
120
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
121
121
 
122
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
122
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
123
123
 
124
124
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
125
125
 
@@ -193,9 +193,11 @@ declare module 'chargebee' {
193
193
 
194
194
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
195
195
 
196
+ billing_override?:{max_excess_payment_usage?:number,max_refundable_credits_usage?:number};
197
+
196
198
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
197
199
 
198
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
200
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
199
201
 
200
202
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
201
203
 
@@ -281,9 +283,11 @@ declare module 'chargebee' {
281
283
 
282
284
  customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
283
285
 
286
+ billing_override?:{max_excess_payment_usage?:number,max_refundable_credits_usage?:number};
287
+
284
288
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
285
289
 
286
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
290
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
287
291
 
288
292
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
289
293
 
@@ -219,7 +219,7 @@ declare module 'chargebee' {
219
219
 
220
220
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
221
221
 
222
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
222
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
223
223
 
224
224
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
225
225
 
@@ -313,7 +313,7 @@ declare module 'chargebee' {
313
313
 
314
314
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
315
315
 
316
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
316
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
317
317
 
318
318
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
319
319
 
@@ -155,6 +155,10 @@ declare module 'chargebee' {
155
155
 
156
156
  stop_dunning(invoice_id:string, input?:StopDunningInputParam):ChargebeeRequest<StopDunningResponse>;
157
157
 
158
+ pause_dunning(invoice_id:string, input:PauseDunningInputParam):ChargebeeRequest<PauseDunningResponse>;
159
+
160
+ resume_dunning(invoice_id:string, input?:ResumeDunningInputParam):ChargebeeRequest<ResumeDunningResponse>;
161
+
158
162
  import_invoice(input:ImportInvoiceInputParam):ChargebeeRequest<ImportInvoiceResponse>;
159
163
 
160
164
  apply_payments(invoice_id:string, input?:ApplyPaymentsInputParam):ChargebeeRequest<ApplyPaymentsResponse>;
@@ -443,6 +447,22 @@ declare module 'chargebee' {
443
447
 
444
448
  comment?:string;
445
449
  }
450
+ export interface PauseDunningResponse {
451
+ invoice:Invoice;
452
+ }
453
+ export interface PauseDunningInputParam {
454
+
455
+ expected_payment_date:number;
456
+
457
+ comment?:string;
458
+ }
459
+ export interface ResumeDunningResponse {
460
+ invoice:Invoice;
461
+ }
462
+ export interface ResumeDunningInputParam {
463
+
464
+ comment?:string;
465
+ }
446
466
  export interface ImportInvoiceResponse {
447
467
  invoice:Invoice;
448
468
 
@@ -470,6 +490,8 @@ declare module 'chargebee' {
470
490
 
471
491
  notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',note?:string}[];
472
492
 
493
+ line_item_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,line_item_id?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
494
+
473
495
  id:string;
474
496
 
475
497
  currency_code?:string;
@@ -773,6 +795,8 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
773
795
  }
774
796
  export interface RetrieveInputParam {
775
797
 
798
+ line_item?:{customer_id?:{is?:string},subscription_id?:{is?:string}};
799
+
776
800
  line_items_limit?:number;
777
801
 
778
802
  line_items_offset?:string;
@@ -1096,7 +1120,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
1096
1120
 
1097
1121
  metered?:boolean;
1098
1122
 
1099
- percentage?:string;
1123
+ is_percentage_pricing?:boolean;
1100
1124
 
1101
1125
  reference_line_item_id?:string;
1102
1126
 
@@ -1291,11 +1315,11 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
1291
1315
  created_at:number;
1292
1316
  }
1293
1317
  export interface Note {
1294
- entity_type:'coupon' | 'subscription' | 'customer' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'tax' | 'plan' | 'addon';
1295
-
1296
1318
  note:string;
1297
1319
 
1298
1320
  entity_id?:string;
1321
+
1322
+ entity_type?:'coupon' | 'subscription' | 'customer' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'tax' | 'plan' | 'addon';
1299
1323
  }
1300
1324
  export interface ShippingAddress {
1301
1325
  first_name?:string;
@@ -120,11 +120,11 @@ declare module 'chargebee' {
120
120
 
121
121
  usage_calculation?:'sum_of_usages' | 'last_usage' | 'max_usage';
122
122
 
123
+ is_percentage_pricing?:boolean;
124
+
123
125
  metadata?:object;
124
126
 
125
127
  business_entity_id?:string;
126
-
127
- is_percentage_pricing?:boolean;
128
128
  }
129
129
  export interface RetrieveResponse {
130
130
  item:Item;
@@ -174,6 +174,8 @@ declare module 'chargebee' {
174
174
  included_in_mrr?:boolean;
175
175
 
176
176
  status?:'active' | 'archived';
177
+
178
+ is_percentage_pricing?:boolean;
177
179
  }
178
180
  export interface ListResponse {
179
181
  list:{item:Item}[];
@@ -56,6 +56,8 @@ declare module 'chargebee' {
56
56
 
57
57
  offset?:string;
58
58
 
59
+ source?:{in?:string,is?:'apple_app_store' | 'google_play_store',is_not?:'apple_app_store' | 'google_play_store',not_in?:string};
60
+
59
61
  /**
60
62
  * @description Chargebee Customer External Identifier
61
63
 
@@ -10,7 +10,7 @@ declare module 'chargebee' {
10
10
 
11
11
  item_parent_id_at_source?:string;
12
12
 
13
- status:'active' | 'expired' | 'cancelled' | 'in_dunning' | 'in_grace_period';
13
+ status:'active' | 'expired' | 'cancelled' | 'in_dunning' | 'in_grace_period' | 'paused';
14
14
 
15
15
  auto_renew_status?:'off' | 'on';
16
16
 
@@ -24,16 +24,20 @@ declare module 'chargebee' {
24
24
 
25
25
  cancelled_at?:number;
26
26
 
27
- cancellation_reason?:'customer_cancelled' | 'customer_did_not_consent_to_price_increase' | 'refunded_due_to_app_issue' | 'refunded_for_other_reason';
27
+ cancellation_reason?:'customer_cancelled' | 'customer_did_not_consent_to_price_increase' | 'refunded_due_to_app_issue' | 'refunded_for_other_reason' | 'merchant_revoked';
28
28
 
29
29
  grace_period_expires_at?:number;
30
30
 
31
+ resumes_at?:number;
32
+
31
33
  has_scheduled_changes:boolean;
32
34
 
33
35
  resource_version?:number;
34
36
 
35
37
  upcoming_renewal?:OmnichannelSubscriptionItem.UpcomingRenewal;
36
38
 
39
+ linked_item?:OmnichannelSubscriptionItem.LinkedItem;
40
+
37
41
  }
38
42
  export namespace OmnichannelSubscriptionItem {
39
43
  export class OmnichannelSubscriptionItemResource {
@@ -67,5 +71,10 @@ declare module 'chargebee' {
67
71
 
68
72
  price_nanos?:number;
69
73
  }
74
+ export interface LinkedItem {
75
+ id:string;
76
+
77
+ linked_at?:number;
78
+ }
70
79
  }
71
80
  }
@@ -34,7 +34,7 @@ declare module 'chargebee' {
34
34
 
35
35
  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};
36
36
 
37
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
37
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
38
38
 
39
39
  redirect_url?:string;
40
40
 
@@ -49,7 +49,7 @@ declare module 'chargebee' {
49
49
 
50
50
  subscription:object;
51
51
 
52
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
52
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
53
53
 
54
54
  redirect_url?:string;
55
55
  }
@@ -16,9 +16,9 @@ declare module 'chargebee' {
16
16
 
17
17
  invoice_id?:string;
18
18
 
19
- status:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed';
19
+ status:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired';
20
20
 
21
- operation_type:'create_subscription_for_customer' | 'change_subscription' | 'onetime_invoice';
21
+ operation_type:'create_subscription_for_customer' | 'change_subscription' | 'onetime_invoice' | 'renew_subscription';
22
22
 
23
23
  vat_number?:string;
24
24
 
@@ -82,6 +82,10 @@ declare module 'chargebee' {
82
82
 
83
83
  deleted:boolean;
84
84
 
85
+ total_contract_value?:number;
86
+
87
+ total_discount?:number;
88
+
85
89
  }
86
90
  export namespace Quote {
87
91
  export class QuoteResource {
@@ -368,11 +372,15 @@ declare module 'chargebee' {
368
372
 
369
373
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
370
374
 
371
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
375
+ billing_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};
376
+
377
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
372
378
 
373
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
379
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
374
380
 
375
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
381
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
382
+
383
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
376
384
 
377
385
  name?:string;
378
386
 
@@ -389,6 +397,10 @@ declare module 'chargebee' {
389
397
  billing_alignment_mode?:BillingAlignmentMode;
390
398
 
391
399
  coupon_ids?:string[];
400
+
401
+ billing_start_option?:BillingStartOption;
402
+
403
+ net_term_days?:number;
392
404
  }
393
405
  export interface EditCreateSubCustomerQuoteForItemsResponse {
394
406
  quote:Quote;
@@ -403,11 +415,15 @@ declare module 'chargebee' {
403
415
 
404
416
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
405
417
 
406
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
418
+ billing_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};
419
+
420
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
407
421
 
408
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
422
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
409
423
 
410
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
424
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
425
+
426
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
411
427
 
412
428
  notes?:string;
413
429
 
@@ -422,6 +438,10 @@ declare module 'chargebee' {
422
438
  billing_alignment_mode?:BillingAlignmentMode;
423
439
 
424
440
  coupon_ids?:string[];
441
+
442
+ billing_start_option?:BillingStartOption;
443
+
444
+ net_term_days?:number;
425
445
  }
426
446
  export interface UpdateSubscriptionQuoteForItemsResponse {
427
447
  quote:Quote;
@@ -440,11 +460,13 @@ declare module 'chargebee' {
440
460
 
441
461
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
442
462
 
443
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
463
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
444
464
 
445
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
465
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
446
466
 
447
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
467
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
468
+
469
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
448
470
 
449
471
  name?:string;
450
472
 
@@ -475,6 +497,8 @@ declare module 'chargebee' {
475
497
  force_term_reset?:boolean;
476
498
 
477
499
  reactivate?:boolean;
500
+
501
+ net_term_days?:number;
478
502
  }
479
503
  export interface EditUpdateSubscriptionQuoteForItemsResponse {
480
504
  quote:Quote;
@@ -493,11 +517,13 @@ declare module 'chargebee' {
493
517
 
494
518
  contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
495
519
 
496
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
520
+ subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
497
521
 
498
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
522
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
499
523
 
500
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
524
+ item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
525
+
526
+ coupons?:{end_date?:number,id?:string,start_date?:number}[];
501
527
 
502
528
  notes?:string;
503
529
 
@@ -526,6 +552,8 @@ declare module 'chargebee' {
526
552
  force_term_reset?:boolean;
527
553
 
528
554
  reactivate?:boolean;
555
+
556
+ net_term_days?:number;
529
557
  }
530
558
  export interface CreateForChargeItemsAndChargesResponse {
531
559
  quote:Quote;
@@ -534,6 +562,8 @@ declare module 'chargebee' {
534
562
  }
535
563
  export interface CreateForChargeItemsAndChargesInputParam {
536
564
 
565
+ billing_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};
566
+
537
567
  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};
538
568
 
539
569
  item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
@@ -569,6 +599,8 @@ declare module 'chargebee' {
569
599
  }
570
600
  export interface EditForChargeItemsAndChargesInputParam {
571
601
 
602
+ billing_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};
603
+
572
604
  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};
573
605
 
574
606
  item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
@@ -648,7 +680,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
648
680
 
649
681
  */
650
682
 
651
- status?:{in?:string,is?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',is_not?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',not_in?:string};
683
+ status?:{in?:string,is?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired',is_not?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed' | 'pending_approval' | 'approval_rejected' | 'proposed' | 'voided' | 'expired',not_in?:string};
652
684
 
653
685
  /**
654
686
  * @description Creation date of the quote. Typically this is the date on which quote is generated.
@@ -725,7 +757,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
725
757
  }
726
758
  export interface UpdateStatusInputParam {
727
759
 
728
- status:'accepted' | 'declined' | 'closed';
760
+ status:'accepted' | 'declined' | 'proposed' | 'voided' | 'closed';
729
761
 
730
762
  comment?:string;
731
763
  }
@@ -795,7 +827,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
795
827
 
796
828
  metered?:boolean;
797
829
 
798
- percentage?:string;
830
+ is_percentage_pricing?:boolean;
799
831
 
800
832
  reference_line_item_id?:string;
801
833
 
@@ -71,7 +71,7 @@ declare module 'chargebee' {
71
71
 
72
72
  metered?:boolean;
73
73
 
74
- percentage?:string;
74
+ is_percentage_pricing?:boolean;
75
75
 
76
76
  reference_line_item_id?:string;
77
77
 
@@ -0,0 +1,147 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface QuotedRamp {
5
+
6
+
7
+ id:string;
8
+
9
+ line_items?:QuotedRamp.LineItem[];
10
+
11
+ discounts?:QuotedRamp.Discount[];
12
+
13
+ item_tiers?:QuotedRamp.ItemTier[];
14
+
15
+ }
16
+ export namespace QuotedRamp {
17
+
18
+
19
+ export interface LineItem {
20
+ item_price_id:string;
21
+
22
+ item_type:'plan' | 'addon' | 'charge';
23
+
24
+ quantity?:number;
25
+
26
+ quantity_in_decimal?:string;
27
+
28
+ metered_quantity?:string;
29
+
30
+ unit_price?:number;
31
+
32
+ unit_price_in_decimal?:string;
33
+
34
+ amount?:number;
35
+
36
+ amount_in_decimal?:string;
37
+
38
+ billing_period?:number;
39
+
40
+ billing_period_unit?:'day' | 'week' | 'month' | 'year';
41
+
42
+ free_quantity?:number;
43
+
44
+ free_quantity_in_decimal?:string;
45
+
46
+ billing_cycles?:number;
47
+
48
+ service_period_days?:number;
49
+
50
+ charge_on_event?:'subscription_creation' | 'subscription_trial_start' | 'plan_activation' | 'subscription_activation' | 'contract_termination';
51
+
52
+ charge_once?:boolean;
53
+
54
+ charge_on_option?:'immediately' | 'on_event';
55
+
56
+ start_date?:number;
57
+
58
+ end_date?:number;
59
+
60
+ ramp_tier_id?:string;
61
+
62
+ discount_amount?:number;
63
+
64
+ md_discount_amount?:string;
65
+
66
+ item_level_discount_amount?:number;
67
+
68
+ md_item_level_discount_amount?:string;
69
+
70
+ discount_per_billing_cycle?:number;
71
+
72
+ discount_per_billing_cycle_in_decimal?:string;
73
+
74
+ item_level_discount_per_billing_cycle?:number;
75
+
76
+ item_level_discount_per_billing_cycle_in_decimal?:string;
77
+
78
+ net_amount?:number;
79
+
80
+ md_net_amount?:string;
81
+
82
+ amount_per_billing_cycle?:number;
83
+
84
+ amount_per_billing_cycle_in_decimal?:string;
85
+
86
+ net_amount_per_billing_cycle?:number;
87
+
88
+ net_amount_per_billing_cycle_in_decimal?:string;
89
+ }
90
+ export interface Discount {
91
+ id:string;
92
+
93
+ name:string;
94
+
95
+ invoice_name?:string;
96
+
97
+ type:'fixed_amount' | 'percentage';
98
+
99
+ percentage?:number;
100
+
101
+ amount?:number;
102
+
103
+ duration_type:'one_time' | 'forever' | 'limited_period';
104
+
105
+ entity_type:'item_level_coupon' | 'document_level_coupon' | 'item_level_discount' | 'document_level_discount';
106
+
107
+ entity_id?:string;
108
+
109
+ period?:number;
110
+
111
+ period_unit?:'day' | 'week' | 'month' | 'year';
112
+
113
+ included_in_mrr:boolean;
114
+
115
+ apply_on:'invoice_amount' | 'specific_item_price';
116
+
117
+ apply_on_item_type?:'plan' | 'addon' | 'charge';
118
+
119
+ item_price_id?:string;
120
+
121
+ created_at:number;
122
+
123
+ updated_at?:number;
124
+
125
+ start_date?:number;
126
+
127
+ end_date?:number;
128
+ }
129
+ export interface ItemTier {
130
+ item_price_id:string;
131
+
132
+ starting_unit:number;
133
+
134
+ ending_unit?:number;
135
+
136
+ price:number;
137
+
138
+ starting_unit_in_decimal?:string;
139
+
140
+ ending_unit_in_decimal?:string;
141
+
142
+ price_in_decimal?:string;
143
+
144
+ ramp_tier_id?:string;
145
+ }
146
+ }
147
+ }
@@ -456,7 +456,7 @@ declare module 'chargebee' {
456
456
 
457
457
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
458
458
 
459
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
459
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
460
460
 
461
461
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
462
462
 
@@ -738,6 +738,8 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
738
738
  */
739
739
 
740
740
  offset?:string;
741
+
742
+ sort_by?:{asc?:'created_at',desc?:'created_at'};
741
743
  }
742
744
  export interface ListDiscountsResponse {
743
745
  list:{discount:Discount}[];
@@ -952,7 +954,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
952
954
 
953
955
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
954
956
 
955
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
957
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
956
958
 
957
959
  item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,starting_unit?:number,starting_unit_in_decimal?:string}[];
958
960
 
@@ -1401,7 +1403,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1401
1403
 
1402
1404
  subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
1403
1405
 
1404
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
1406
+ discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
1405
1407
 
1406
1408
  charged_items?:{item_price_id?:string,last_charged_at?:number}[];
1407
1409
 
@@ -0,0 +1,63 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ declare module 'chargebee' {
4
+ export interface UsageFile {
5
+
6
+
7
+ id:string;
8
+
9
+ name:string;
10
+
11
+ mime_type:string;
12
+
13
+ error_code?:string;
14
+
15
+ error_reason?:string;
16
+
17
+ status?:'queued' | 'imported' | 'processing' | 'processed' | 'failed';
18
+
19
+ total_records_count?:number;
20
+
21
+ processed_records_count?:number;
22
+
23
+ failed_records_count?:number;
24
+
25
+ file_size_in_bytes?:number;
26
+
27
+ processing_started_at?:number;
28
+
29
+ processing_completed_at?:number;
30
+
31
+ uploaded_by?:string;
32
+
33
+ uploaded_at?:number;
34
+
35
+ upload_details?:UsageFile.UploadDetail;
36
+
37
+ }
38
+ export namespace UsageFile {
39
+ export class UsageFileResource {
40
+ upload(input:UploadInputParam):ChargebeeRequest<UploadResponse>;
41
+
42
+ status(usage_file_id:string):ChargebeeRequest<StatusResponse>;
43
+ }
44
+ export interface UploadResponse {
45
+ usage_file:UsageFile;
46
+ }
47
+ export interface UploadInputParam {
48
+
49
+ file_name:string;
50
+
51
+ mime_type:string;
52
+ }
53
+ export interface StatusResponse {
54
+ usage_file:UsageFile;
55
+ }
56
+
57
+ export interface UploadDetail {
58
+ url:string;
59
+
60
+ expires_at:number;
61
+ }
62
+ }
63
+ }
@@ -3,153 +3,50 @@
3
3
  declare module 'chargebee' {
4
4
  export interface VirtualBankAccount {
5
5
 
6
- /**
7
- * @description Identifier of the virtual bank account
8
6
 
9
- */
10
-
11
7
  id:string;
12
-
13
- /**
14
- * @description Identifier of the customer.
15
8
 
16
- */
17
-
18
9
  customer_id:string;
19
-
20
- /**
21
- * @description Email address associated with the virtual bank account
22
10
 
23
- */
24
-
25
11
  email:string;
26
-
27
- /**
28
- * @description type of the credit transfer \* ach_credit - ACH Credit Transfer \* sepa_credit - SEPA Credit Transfer
29
12
 
30
- */
31
-
32
- scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
33
-
34
- /**
35
- * @description Name of the bank
13
+ scheme?:'ach_credit' | 'sepa_credit' | 'us_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer';
36
14
 
37
- */
38
-
39
15
  bank_name?:string;
40
-
41
- /**
42
- * @description The account number to which funds will be transferred.
43
16
 
44
- */
45
-
46
17
  account_number:string;
47
-
48
- /**
49
- * @description The routing number of the bank
50
18
 
51
- */
52
-
53
19
  routing_number?:string;
54
-
55
- /**
56
- * @description Swift code of the bank in which the account exists.
57
20
 
58
- */
59
-
60
- swift_code:string;
61
-
62
- /**
63
- * @description Name of the gateway this virtual bank account is stored in. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* bank_of_america - Bank of America Gateway \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
21
+ swift_code?:string;
64
22
 
65
- */
66
-
67
23
  gateway:Gateway;
68
-
69
- /**
70
- * @description The gateway account in which this virtual bank account is stored.
71
24
 
72
- */
73
-
74
25
  gateway_account_id:string;
75
-
76
- /**
77
- * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
78
26
 
79
- */
80
-
81
27
  resource_version?:number;
82
-
83
- /**
84
- * @description Timestamp indicating when this virtual bank account resource was last updated.
85
28
 
86
- */
87
-
88
29
  updated_at?:number;
89
-
90
- /**
91
- * @description Timestamp indicating when this virtual bank account resource is created.
92
30
 
93
- */
94
-
95
31
  created_at:number;
96
-
97
- /**
98
- * @description Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).
99
32
 
100
- */
101
-
102
33
  reference_id:string;
103
-
104
- /**
105
- * @description Indicates that this resource has been deleted.
106
34
 
107
- */
108
-
109
35
  deleted:boolean;
36
+
110
37
  }
111
38
  export namespace VirtualBankAccount {
112
39
  export class VirtualBankAccountResource {
113
- /**
114
- * @description Creates a virtual bank account using the identifier provided by the gateway.
115
-
116
- */
117
-
118
40
  create_using_permanent_token(input:CreateUsingPermanentTokenInputParam):ChargebeeRequest<CreateUsingPermanentTokenResponse>;
119
41
 
120
- /**
121
- * @description Creates a virtual bank account for a customer. Email address is mandatory for virtual bank account creation. All notifications related to this virtual bank account will be sent to the email address you specify.
122
-
123
- */
124
-
125
42
  create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
126
43
 
127
- /**
128
- * @description Retrieves the virtual bank account identified by the unique identifier.
129
-
130
- */
131
-
132
44
  retrieve(virtual_bank_account_id:string):ChargebeeRequest<RetrieveResponse>;
133
45
 
134
- /**
135
- * @description Lists all the virtual bank accounts.
136
-
137
- */
138
-
139
46
  list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
140
47
 
141
- /**
142
- * @description Deletes a virtual bank account. If there is no virtual bank account present in the gateway for the customer, this API will return successfully without throwing an error.
143
-
144
- */
145
-
146
48
  delete(virtual_bank_account_id:string):ChargebeeRequest<DeleteResponse>;
147
49
 
148
- /**
149
- * @description Deletes virtual bank accounts from Chargebee. Payment method in the payment gateway, and Auto Collection settings in Chargebee are not affected.
150
-
151
- */
152
-
153
50
  delete_local(virtual_bank_account_id:string):ChargebeeRequest<DeleteLocalResponse>;
154
51
  }
155
52
  export interface CreateUsingPermanentTokenResponse {
@@ -159,26 +56,11 @@ declare module 'chargebee' {
159
56
  }
160
57
  export interface CreateUsingPermanentTokenInputParam {
161
58
 
162
- /**
163
- * @description Identifier of the customer.
164
-
165
- */
166
-
167
59
  customer_id:string;
168
60
 
169
- /**
170
- * @description Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).
171
-
172
- */
173
-
174
61
  reference_id:string;
175
62
 
176
- /**
177
- * @description type of the credit transfer. \* sepa_credit - SEPA Credit Transfer \* ach_credit - ACH Credit Transfer
178
-
179
- */
180
-
181
- scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
63
+ scheme?:'ach_credit' | 'sepa_credit' | 'us_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer';
182
64
  }
183
65
  export interface CreateResponse {
184
66
  virtual_bank_account:VirtualBankAccount;
@@ -187,78 +69,53 @@ declare module 'chargebee' {
187
69
  }
188
70
  export interface CreateInputParam {
189
71
 
190
- /**
191
- * @description Identifier of the customer.
192
-
193
- */
194
-
195
72
  customer_id:string;
196
73
 
197
- /**
198
- * @description Email address associated with the virtual bank account.
199
-
200
- */
201
-
202
74
  email?:string;
203
75
 
204
- /**
205
- * @description type of the credit transfer. \* sepa_credit - SEPA Credit Transfer \* ach_credit - ACH Credit Transfer
206
-
207
- */
208
-
209
- scheme?:'eu_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'ach_credit' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit';
76
+ scheme?:'ach_credit' | 'sepa_credit' | 'us_automated_bank_transfer' | 'gb_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer';
210
77
  }
211
78
  export interface RetrieveResponse {
212
79
  virtual_bank_account:VirtualBankAccount;
213
80
  }
214
81
 
215
82
  export interface ListResponse {
216
- /**
217
- * @description Lists all the virtual bank accounts.
218
-
219
- */
220
-
221
83
  list:{virtual_bank_account:VirtualBankAccount}[];
222
84
 
223
- /**
224
- * @description Lists all the virtual bank accounts.
225
-
226
- */
227
-
228
85
  next_offset?:string;
229
86
  }
230
87
  export interface ListInputParam {
231
88
  [key : string]: any;
232
89
  /**
233
- * @description Lists all the virtual bank accounts.
90
+ * @description The number of resources to be returned.
234
91
 
235
92
  */
236
93
 
237
94
  limit?:number;
238
95
 
239
96
  /**
240
- * @description Lists all the virtual bank accounts.
97
+ * @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.
241
98
 
242
99
  */
243
100
 
244
101
  offset?:string;
245
102
 
246
103
  /**
247
- * @description Lists all the virtual bank accounts.
104
+ * @description Identifier of the customer.
248
105
 
249
106
  */
250
107
 
251
108
  customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
252
109
 
253
110
  /**
254
- * @description Lists all the virtual bank accounts.
111
+ * @description Timestamp indicating when this virtual bank account resource was last updated.
255
112
 
256
113
  */
257
114
 
258
115
  updated_at?:{after?:string,before?:string,between?:string,on?:string};
259
116
 
260
117
  /**
261
- * @description Lists all the virtual bank accounts.
118
+ * @description Timestamp indicating when this virtual bank account resource is created.
262
119
 
263
120
  */
264
121