chargebee 2.50.0 → 2.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/CHANGELOG.md +92 -0
  2. package/lib/chargebee.js +1 -1
  3. package/lib/resources/api_endpoints.js +37 -1
  4. package/package.json +1 -1
  5. package/types/core.d.ts +8 -5
  6. package/types/index.d.ts +3 -0
  7. package/types/resources/Address.d.ts +2 -194
  8. package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
  9. package/types/resources/Attribute.d.ts +4 -1
  10. package/types/resources/BillingConfiguration.d.ts +21 -0
  11. package/types/resources/Brand.d.ts +12 -0
  12. package/types/resources/BusinessEntity.d.ts +8 -6
  13. package/types/resources/BusinessEntityTransfer.d.ts +10 -7
  14. package/types/resources/Card.d.ts +11 -311
  15. package/types/resources/Comment.d.ts +7 -124
  16. package/types/resources/Configuration.d.ts +2 -0
  17. package/types/resources/Contact.d.ts +2 -44
  18. package/types/resources/ContractTerm.d.ts +4 -72
  19. package/types/resources/Coupon.d.ts +0 -37
  20. package/types/resources/CouponCode.d.ts +67 -35
  21. package/types/resources/CouponSet.d.ts +12 -121
  22. package/types/resources/CreditNote.d.ts +2 -6
  23. package/types/resources/CreditNoteEstimate.d.ts +1 -1
  24. package/types/resources/Currency.d.ts +8 -5
  25. package/types/resources/Customer.d.ts +90 -89
  26. package/types/resources/Discount.d.ts +2 -89
  27. package/types/resources/Download.d.ts +2 -14
  28. package/types/resources/Entitlement.d.ts +15 -103
  29. package/types/resources/EntitlementOverride.d.ts +4 -89
  30. package/types/resources/Estimate.d.ts +6 -10
  31. package/types/resources/Event.d.ts +23 -108
  32. package/types/resources/Export.d.ts +116 -432
  33. package/types/resources/Feature.d.ts +17 -319
  34. package/types/resources/GatewayErrorDetail.d.ts +6 -48
  35. package/types/resources/Gift.d.ts +34 -294
  36. package/types/resources/Hierarchy.d.ts +4 -24
  37. package/types/resources/ImpactedItem.d.ts +4 -36
  38. package/types/resources/ImpactedItemPrice.d.ts +5 -2
  39. package/types/resources/ImpactedSubscription.d.ts +3 -30
  40. package/types/resources/InAppSubscription.d.ts +13 -355
  41. package/types/resources/Invoice.d.ts +26 -18
  42. package/types/resources/InvoiceEstimate.d.ts +1 -1
  43. package/types/resources/Item.d.ts +4 -9
  44. package/types/resources/ItemEntitlement.d.ts +15 -155
  45. package/types/resources/NonSubscription.d.ts +9 -6
  46. package/types/resources/OmnichannelSubscriptionItem.d.ts +9 -0
  47. package/types/resources/PaymentIntent.d.ts +9 -255
  48. package/types/resources/PaymentReferenceNumber.d.ts +3 -20
  49. package/types/resources/PaymentSource.d.ts +2 -2
  50. package/types/resources/PaymentVoucher.d.ts +20 -203
  51. package/types/resources/PortalSession.d.ts +4 -146
  52. package/types/resources/PromotionalCredit.d.ts +10 -215
  53. package/types/resources/Purchase.d.ts +3 -1
  54. package/types/resources/Quote.d.ts +68 -18
  55. package/types/resources/QuoteLineGroup.d.ts +1 -1
  56. package/types/resources/QuotedRamp.d.ts +142 -0
  57. package/types/resources/RecordedPurchase.d.ts +2 -0
  58. package/types/resources/ResourceMigration.d.ts +2 -54
  59. package/types/resources/SiteMigrationDetail.d.ts +13 -55
  60. package/types/resources/Subscription.d.ts +13 -9
  61. package/types/resources/SubscriptionEntitlement.d.ts +6 -106
  62. package/types/resources/SubscriptionEstimate.d.ts +14 -11
  63. package/types/resources/TaxWithheld.d.ts +14 -26
  64. package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
  65. package/types/resources/TimeMachine.d.ts +3 -64
  66. package/types/resources/Token.d.ts +3 -60
  67. package/types/resources/Transaction.d.ts +2 -2
  68. package/types/resources/Usage.d.ts +21 -165
package/CHANGELOG.md CHANGED
@@ -1,3 +1,95 @@
1
+ ### v2.52.0 (2025-07-18)
2
+ * * *
3
+
4
+ ### New Resources:
5
+ * BillingConfiguration has been added.
6
+ * Brand has been added.
7
+
8
+ ### New Attributes:
9
+ * has_children has been added to Hierarchy
10
+ * coupon_applicability_mappings has been added to QuotedRamp.
11
+
12
+ ### New Endpoint:
13
+ * listHierarchyDetail has been added to Customer.
14
+
15
+ ### New Input parameters:
16
+ * change_reason children has been added to Entitlement#CreateRequest.
17
+ * entitlements[apply_grandfathering] has been added to Entitlement#CreateRequest.
18
+ * replace_primary_payment_source has been added to Purchase#CreateRequest.
19
+ * omnichannel_subscription has been added to RecordedPurchase#CreateRequest.
20
+ * contract_term has been added to Subscription#RemoveScheduledCancellationRequest.
21
+ * contract_term_billing_cycle_on_renewal has been added to Subscription#RemoveScheduledCancellationRequest.
22
+
23
+ ### New Enums:
24
+ * payconiq_by_bancontact has been added to PaymentMethodType.
25
+ * solidgate has been added to Gateway.
26
+ * solidgate has been added to PaymentMethod.
27
+
28
+ ### v2.51.0 (2025-06-19)
29
+ * * *
30
+
31
+ ### New Resources
32
+ * QuotedRamp has been added.
33
+
34
+ ### New Attributes
35
+ * chargebee_response_schema_type has been added to Configuration.
36
+ * linked_item has been added to OmnichannelSubscriptionItem.
37
+ * resumes_at has been added to OmnichannelSubscriptionItem.
38
+
39
+ ### Changed Attributes
40
+ * percentage changed to is_percentage_pricing in CreditNote.
41
+ * percentage changed to is_percentage_pricing in QuoteLineGroup.
42
+ * percentage changed to is_percentage_pricing in CreditNoteEstimate.
43
+ * percentage changed to is_percentage_pricing in Invoice.
44
+ * percentage changed to is_percentage_pricing in InvoiceEstimate.
45
+ * percentage changed to is_percentage_pricing in Quote.
46
+
47
+
48
+ ### New Input Parameters
49
+ * is_percentage_pricing has been added to Item#UpdateRequest.
50
+ * line_item[subscription_id] has been added to CreditNote#RetrieveRequest.
51
+ * line_item[customer_id] has been added to CreditNote#RetrieveRequest.
52
+ * line_item[subscription_id] has been added to Invoice#RetrieveRequest.
53
+ * line_item[customer_id] has been added to Invoice#RetrieveRequest.
54
+ * billing_override[max_excess_payment_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
55
+ * billing_override[max_refundable_credits_usage] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
56
+ * billing_override[max_excess_payment_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
57
+ * billing_override[max_refundable_credits_usage] has been added to Estimate#UpdateSubscriptionForItemsRequest.
58
+ * billing_start_option has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
59
+ * net_term_days has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
60
+ * billing_address has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
61
+ * subscription_items has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
62
+ * discounts has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
63
+ * billing_start_option has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
64
+ * net_term_days has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
65
+ * billing_address has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
66
+ * subscription_items has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
67
+ * discounts has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
68
+ * net_term_days has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
69
+ * subscription_items has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
70
+ * discount has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
71
+ * coupons has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
72
+ * net_term_days has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
73
+ * subscription_items has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
74
+ * discounts has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
75
+ * coupons has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
76
+ * billing_address has been added to Quote#CreateForChargeItemsAndChargesRequest.
77
+ * billing_address has been added to Quote#EditForChargeItemsAndChargesRequest.
78
+ * sort_by[order] has been added to Subscription#SubscriptionContractTermsForSubscriptionRequest.
79
+ * item_tiers has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
80
+ * item_tiers has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
81
+ * item_tiers has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
82
+ * item_tiers has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
83
+
84
+ ### New Endpoints:
85
+ * PauseDunningRequest has been added to Invoice.
86
+ * ResumeDunningRequest has been added to Invoice.
87
+
88
+ ### Enum Attributes:
89
+ * BillingPeriodUnitEnum has been added.
90
+ * BillingStartOptionEnum has been added.
91
+ * OMNICHANNEL_SUBSCRIPTION_ITEM_RESUMED has been added to EventTypeEnum.
92
+
1
93
  ### v2.50.0 (2025-05-15)
2
94
  * * *
3
95
 
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.50.0',
14
+ clientVersion: 'v2.52.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -702,6 +702,17 @@ var _endpoints = {
702
702
  {
703
703
  }
704
704
  ],
705
+ [
706
+ "list_hierarchy_detail",
707
+ "GET",
708
+ "/customers",
709
+ "/hierarchy_detail",
710
+ true,
711
+ null,
712
+ false,
713
+ {
714
+ }
715
+ ],
705
716
  [
706
717
  "update_hierarchy_settings",
707
718
  "POST",
@@ -1159,6 +1170,28 @@ var _endpoints = {
1159
1170
  {
1160
1171
  }
1161
1172
  ],
1173
+ [
1174
+ "pause_dunning",
1175
+ "POST",
1176
+ "/invoices",
1177
+ "/pause_dunning",
1178
+ true,
1179
+ null,
1180
+ false,
1181
+ {
1182
+ }
1183
+ ],
1184
+ [
1185
+ "resume_dunning",
1186
+ "POST",
1187
+ "/invoices",
1188
+ "/resume_dunning",
1189
+ true,
1190
+ null,
1191
+ false,
1192
+ {
1193
+ }
1194
+ ],
1162
1195
  [
1163
1196
  "import_invoice",
1164
1197
  "POST",
@@ -2772,6 +2805,8 @@ var _endpoints = {
2772
2805
  ],
2773
2806
  "quoted_subscription": [],
2774
2807
  "quoted_charge": [],
2808
+ "quoted_ramp": [],
2809
+ "billing_configuration": [],
2775
2810
  "quote_line_group": [],
2776
2811
  "plan": [
2777
2812
  [
@@ -4755,6 +4790,7 @@ var _endpoints = {
4755
4790
  {
4756
4791
  }
4757
4792
  ]
4758
- ]
4793
+ ],
4794
+ "brand": []
4759
4795
  };
4760
4796
  module.exports = _endpoints;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name":"chargebee",
3
- "version":"2.50.0",
3
+ "version":"2.52.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,11 +47,11 @@ 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' | 'omnichannel_subscription_item_paused' | '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'
51
- type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'gocardless' | 'not_applicable'
54
+ type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'gocardless' | 'not_applicable'
52
55
  type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
53
56
  type InvoiceDunningHandling = 'continue' | 'stop'
54
57
  type ItemType = 'plan' | 'addon' | 'charge'
@@ -60,8 +63,8 @@ declare module 'chargebee' {
60
63
  type OperationType = 'add' | 'remove'
61
64
  type PauseOption = 'immediately' | 'end_of_term' | 'specific_date' | 'billing_cycles'
62
65
  type PaymentInitiator = 'customer' | 'merchant'
63
- type PaymentMethod = 'cash' | 'check' | 'bank_transfer' | 'other' | 'custom' | 'chargeback' | 'card' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
64
- type PaymentMethodType = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
66
+ type PaymentMethod = 'cash' | 'check' | 'bank_transfer' | 'other' | 'custom' | 'chargeback' | 'card' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
67
+ type PaymentMethodType = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
65
68
  type PaymentVoucherType = 'boleto'
66
69
  type PeriodUnit = 'day' | 'week' | 'month' | 'year'
67
70
  type PriceType = 'tax_exclusive' | 'tax_inclusive'
@@ -83,7 +86,7 @@ declare module 'chargebee' {
83
86
  type Taxability = 'taxable' | 'exempt'
84
87
  type TaxjarExemptionCategory = 'wholesale' | 'government' | 'other'
85
88
  type TrialEndAction = 'site_default' | 'plan_default' | 'activate_subscription' | 'cancel_subscription'
86
- type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
89
+ type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
87
90
  type UnbilledChargesHandling = 'no_action' | 'invoice'
88
91
  type UnbilledChargesOption = 'invoice' | 'delete'
89
92
  type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection'
package/types/index.d.ts CHANGED
@@ -3,6 +3,8 @@
3
3
  ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
4
4
  ///<reference path='./resources/AttachedItem.d.ts' />
5
5
  ///<reference path='./resources/Attribute.d.ts' />
6
+ ///<reference path='./resources/BillingConfiguration.d.ts' />
7
+ ///<reference path='./resources/Brand.d.ts' />
6
8
  ///<reference path='./resources/BusinessEntity.d.ts' />
7
9
  ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
8
10
  ///<reference path='./resources/Card.d.ts' />
@@ -64,6 +66,7 @@
64
66
  ///<reference path='./resources/Quote.d.ts' />
65
67
  ///<reference path='./resources/QuoteLineGroup.d.ts' />
66
68
  ///<reference path='./resources/QuotedCharge.d.ts' />
69
+ ///<reference path='./resources/QuotedRamp.d.ts' />
67
70
  ///<reference path='./resources/QuotedSubscription.d.ts' />
68
71
  ///<reference path='./resources/Ramp.d.ts' />
69
72
  ///<reference path='./resources/RecordedPurchase.d.ts' />
@@ -1,140 +1,46 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
2
3
  declare module 'chargebee' {
3
4
  export interface Address {
4
5
 
5
- /**
6
- * @description Label to identify the address. This is unique for all the address for a subscription.
7
6
 
8
- */
9
-
10
7
  label:string;
11
-
12
- /**
13
- * @description First name
14
8
 
15
- */
16
-
17
9
  first_name?:string;
18
-
19
- /**
20
- * @description Last name
21
10
 
22
- */
23
-
24
11
  last_name?:string;
25
-
26
- /**
27
- * @description Email
28
12
 
29
- */
30
-
31
13
  email?:string;
32
-
33
- /**
34
- * @description Company name
35
14
 
36
- */
37
-
38
15
  company?:string;
39
-
40
- /**
41
- * @description Phone number
42
16
 
43
- */
44
-
45
17
  phone?:string;
46
-
47
- /**
48
- * @description Address line 1
49
18
 
50
- */
51
-
52
19
  addr?:string;
53
-
54
- /**
55
- * @description Address line 2
56
20
 
57
- */
58
-
59
21
  extended_addr?:string;
60
-
61
- /**
62
- * @description Address line 3
63
22
 
64
- */
65
-
66
23
  extended_addr2?:string;
67
-
68
- /**
69
- * @description Name of the city
70
24
 
71
- */
72
-
73
25
  city?:string;
74
-
75
- /**
76
- * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
77
26
 
78
- */
79
-
80
27
  state_code?:string;
81
-
82
- /**
83
- * @description State or Province
84
28
 
85
- */
86
-
87
29
  state?:string;
88
-
89
- /**
90
- * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).
91
30
 
92
- **Note** : If you enter an invalid country code, the system will return an error.
93
-
94
- **Brexit**
95
-
96
-
97
- If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
98
-
99
- */
100
-
101
31
  country?:string;
102
-
103
- /**
104
- * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
105
32
 
106
- */
107
-
108
33
  zip?:string;
109
-
110
- /**
111
- * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
112
34
 
113
- */
114
-
115
35
  validation_status?:ValidationStatus;
116
-
117
- /**
118
- * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
119
36
 
120
- */
121
-
122
37
  subscription_id:string;
38
+
123
39
  }
124
40
  export namespace Address {
125
41
  export class AddressResource {
126
- /**
127
- * @description Retrieves an address resource for a subscription and the specified label.
128
-
129
- */
130
-
131
42
  retrieve(input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
132
43
 
133
- /**
134
- * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
135
-
136
- */
137
-
138
44
  update(input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
139
45
  }
140
46
  export interface RetrieveResponse {
@@ -142,18 +48,8 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
142
48
  }
143
49
  export interface RetrieveInputParam {
144
50
 
145
- /**
146
- * @description Retrieves an address resource for a subscription and the specified label.
147
-
148
- */
149
-
150
51
  subscription_id:string;
151
52
 
152
- /**
153
- * @description Retrieves an address resource for a subscription and the specified label.
154
-
155
- */
156
-
157
53
  label:string;
158
54
  }
159
55
  export interface UpdateResponse {
@@ -161,124 +57,36 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
161
57
  }
162
58
  export interface UpdateInputParam {
163
59
 
164
- /**
165
- * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
166
-
167
- */
168
-
169
60
  subscription_id:string;
170
61
 
171
- /**
172
- * @description Label to identify the address. This is unique for all the address for a subscription.
173
-
174
- */
175
-
176
62
  label:string;
177
63
 
178
- /**
179
- * @description First name.
180
-
181
- */
182
-
183
64
  first_name?:string;
184
65
 
185
- /**
186
- * @description Last name.
187
-
188
- */
189
-
190
66
  last_name?:string;
191
67
 
192
- /**
193
- * @description Email.
194
-
195
- */
196
-
197
68
  email?:string;
198
69
 
199
- /**
200
- * @description Company name.
201
-
202
- */
203
-
204
70
  company?:string;
205
71
 
206
- /**
207
- * @description Phone number.
208
-
209
- */
210
-
211
72
  phone?:string;
212
73
 
213
- /**
214
- * @description Address line 1.
215
-
216
- */
217
-
218
74
  addr?:string;
219
75
 
220
- /**
221
- * @description Address line 2.
222
-
223
- */
224
-
225
76
  extended_addr?:string;
226
77
 
227
- /**
228
- * @description Address line 3.
229
-
230
- */
231
-
232
78
  extended_addr2?:string;
233
79
 
234
- /**
235
- * @description Name of the city.
236
-
237
- */
238
-
239
80
  city?:string;
240
81
 
241
- /**
242
- * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
243
-
244
- */
245
-
246
82
  state_code?:string;
247
83
 
248
- /**
249
- * @description The state/province name. Is set by Chargebee automatically for US, Canada and India If &#x60;state_code&#x60; is provided.
250
-
251
- */
252
-
253
84
  state?:string;
254
85
 
255
- /**
256
- * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
257
-
258
- */
259
-
260
86
  zip?:string;
261
87
 
262
- /**
263
- * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).
264
-
265
- **Note** : If you enter an invalid country code, the system will return an error.
266
-
267
- **Brexit**
268
-
269
-
270
- If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
271
- .
272
-
273
- */
274
-
275
88
  country?:string;
276
89
 
277
- /**
278
- * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
279
-
280
- */
281
-
282
90
  validation_status?:ValidationStatus;
283
91
  }
284
92