chargebee 2.49.1 → 2.50.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,37 @@
1
+ ### v2.50.0 (2025-05-15)
2
+ * * *
3
+
4
+ ### New Resources
5
+ * UsageFile has been added.
6
+
7
+ ### Input Parameter
8
+ * discount[apply_on] has been made optional from required in Estimate#CreateSubItemEstimateRequest.
9
+ * discount[apply_on] has been made optional from required in Estimate#CreateSubItemForCustomerEstimateRequest.
10
+ * discount[apply_on] has been made optional from required in Estimate#UpdateSubscriptionForItemsRequest.
11
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
12
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
13
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
14
+ * discount[apply_on] has been made optional from required in HostedPage#CheckoutNewForItemsRequest.
15
+ * discount[apply_on] has been made optional from required in PricingPageSession#CheckoutNewForItemsRequest.
16
+ * discount[apply_on] has been made optional from required in PricingPageSession#CreateForExistingSubscriptionRequest.
17
+ * discount[apply_on] has been made optional from required in Quote#CreateSubItemsForCustomerQuoteRequest.
18
+ * discount[apply_on] has been made optional from required in Quote#EditCreateSubCustomerQuoteForItemsRequest.
19
+ * discount[apply_on] has been made optional from required in Quote#UpdateSubscriptionQuoteForItemsRequest.
20
+ * discount[apply_on] has been made optional from required in Quote#EditUpdateSubscriptionQuoteForItemsRequest.
21
+ * discount[apply_on] has been made optional from required in Subscription#CreateWithItemsRequest.
22
+ * discount[apply_on] has been made optional from required in Subscription#UpdateForItemsRequest.
23
+ * discount[apply_on] has been made optional from required in Subscription#ImportForItemsRequest.
24
+ * line_item_addresses[] has been added to Invoice#ImportInvoiceRequest.
25
+ * source has been added to OmnichannelSubscription#OmnichannelSubscriptionListRequest.
26
+
27
+ ### Attributes:
28
+ * swift_code has been made optional from required in VirtualBankAccount.
29
+
30
+ ### Enum Attributes:
31
+ * OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSED has been added to EventTypeEnum.
32
+ * PAUSED has been added to OmnichannelSubscriptionItem#StatusEnum.
33
+ * MERCHANT_REVOKED has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
34
+
1
35
  ### v2.49.1 (2025-04-25)
2
36
  * * *
3
37
 
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.50.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -4731,6 +4731,30 @@ var _endpoints = {
4731
4731
  }
4732
4732
  ]
4733
4733
  ],
4734
- "omnichannel_subscription_item_scheduled_change": []
4734
+ "omnichannel_subscription_item_scheduled_change": [],
4735
+ "usage_file": [
4736
+ [
4737
+ "upload",
4738
+ "POST",
4739
+ "/usage_files",
4740
+ "/upload",
4741
+ false,
4742
+ "file-ingest",
4743
+ false,
4744
+ {
4745
+ }
4746
+ ],
4747
+ [
4748
+ "status",
4749
+ "GET",
4750
+ "/usage_files",
4751
+ "/status",
4752
+ true,
4753
+ "file-ingest",
4754
+ false,
4755
+ {
4756
+ }
4757
+ ]
4758
+ ]
4735
4759
  };
4736
4760
  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.50.0",
4
4
  "description":"A library for integrating with ChargeBee.",
5
5
  "keywords":[
6
6
  "payments",
package/types/core.d.ts CHANGED
@@ -44,7 +44,7 @@ declare module 'chargebee' {
44
44
  type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
45
45
  type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant' | 'omnichannel_subscription' | 'omnichannel_subscription_item' | 'omnichannel_transaction' | 'recorded_purchase' | 'omnichannel_subscription_item_scheduled_change' | 'sales_order'
46
46
  type EventName = 'cancellation_page_loaded'
47
- type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'subscription_entitlements_updated' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'omnichannel_subscription_created' | 'omnichannel_subscription_item_renewed' | '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'
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' | 'omnichannel_subscription_item_paused' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
48
48
  type ExportType = 'data' | 'import_friendly_data'
49
49
  type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
50
50
  type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
package/types/index.d.ts CHANGED
@@ -81,6 +81,7 @@
81
81
  ///<reference path='./resources/UnbilledCharge.d.ts' />
82
82
  ///<reference path='./resources/Usage.d.ts' />
83
83
  ///<reference path='./resources/UsageEvent.d.ts' />
84
+ ///<reference path='./resources/UsageFile.d.ts' />
84
85
  ///<reference path='./resources/VirtualBankAccount.d.ts' />
85
86
 
86
87
  declare module 'chargebee' {
@@ -142,6 +143,7 @@ declare module 'chargebee' {
142
143
  static unbilled_charge: UnbilledCharge.UnbilledChargeResource;
143
144
  static usage: Usage.UsageResource;
144
145
  static usage_event: UsageEvent.UsageEventResource;
146
+ static usage_file: UsageFile.UsageFileResource;
145
147
  static virtual_bank_account: VirtualBankAccount.VirtualBankAccountResource;
146
148
 
147
149
  }
@@ -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
 
@@ -195,7 +195,7 @@ declare module 'chargebee' {
195
195
 
196
196
  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
197
 
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}[];
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}[];
199
199
 
200
200
  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
201
 
@@ -283,7 +283,7 @@ declare module 'chargebee' {
283
283
 
284
284
  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
285
 
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}[];
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}[];
287
287
 
288
288
  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
289
 
@@ -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
 
@@ -470,6 +470,8 @@ declare module 'chargebee' {
470
470
 
471
471
  notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',note?:string}[];
472
472
 
473
+ 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}[];
474
+
473
475
  id:string;
474
476
 
475
477
  currency_code?:string;
@@ -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,7 +24,7 @@ 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
 
@@ -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
  }
@@ -370,7 +370,7 @@ declare module 'chargebee' {
370
370
 
371
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}[];
372
372
 
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}[];
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}[];
374
374
 
375
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}[];
376
376
 
@@ -405,7 +405,7 @@ declare module 'chargebee' {
405
405
 
406
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}[];
407
407
 
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}[];
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}[];
409
409
 
410
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}[];
411
411
 
@@ -442,7 +442,7 @@ declare module 'chargebee' {
442
442
 
443
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}[];
444
444
 
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}[];
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}[];
446
446
 
447
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}[];
448
448
 
@@ -495,7 +495,7 @@ declare module 'chargebee' {
495
495
 
496
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}[];
497
497
 
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}[];
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}[];
499
499
 
500
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}[];
501
501
 
@@ -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
 
@@ -952,7 +952,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
952
952
 
953
953
  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
954
 
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}[];
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}[];
956
956
 
957
957
  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
958
 
@@ -1401,7 +1401,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
1401
1401
 
1402
1402
  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
1403
 
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}[];
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}[];
1405
1405
 
1406
1406
  charged_items?:{item_price_id?:string,last_charged_at?:number}[];
1407
1407
 
@@ -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