chargebee 2.72.0 → 2.73.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 29eeb65b66c6c0181993d43b31d7cbf036f210f833b338a187df568405daaf8c
4
- data.tar.gz: 5b826c6b6c69a5feaefa487e7a5d3e0541e7fc88b83589cdee35e66acd0f13ac
3
+ metadata.gz: d1f2cda6e3cacf173db81e42711a723f52c44af02441c0d2bd57e71c4dc7683c
4
+ data.tar.gz: cbe83647e69abd0e88dcaf8b1691e268c3cccf25b15c3fa48846542e9c223e9f
5
5
  SHA512:
6
- metadata.gz: 6d3b4a9de6d1ddb58f76028075a007b4e5a46849c030f2cf70808d580f80ed9860731743c111d351c0a950f45ec8190876b7f68756e4fb992638c50451f68f08
7
- data.tar.gz: e901f416702bbcd73512aea70f70fb238d37134e90385657616e94a2f0a9a51ca9f84b982985ff3593c10df133d99fe129c28bcac0f5c32fd5e67bb69c1cf00c
6
+ metadata.gz: abc1454a8e5281349d0fe4f42dbaed321fa935dc803c11a8252e619a6b2d7b6f623bfe96f6081a3d4a5abc8f9daa992de805f6191858e82110ac446b0fc0cdb2
7
+ data.tar.gz: cbb00c831478d8924d40a4352c6fbe51429c1ace5f75bf3a70b9198c71ff79f8f8b87ea565b3c7b41dd20a5b26160786ebdee082456b68768e05a81f91e010b2
data/CHANGELOG.md CHANGED
@@ -1,3 +1,40 @@
1
+ ### v2.73.0 (2026-06-12)
2
+ * * *
3
+ ### New Resources:
4
+ - [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks) has been added.
5
+ - [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances) has been added.
6
+ - [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations) has been added.
7
+ - [`PromotionalGrant`](https://apidocs.chargebee.com/docs/api/promotional_grants) has been added.
8
+
9
+
10
+ ### New Attributes:
11
+ - [`notes`](https://apidocs.chargebee.com/docs/api/credit_notes/credit-note-object#notes) has been added to [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
12
+ - [`layout`](https://apidocs.chargebee.com/docs/api/hosted_pages/hosted-page-object#layout) has been added to [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).
13
+
14
+
15
+ ### New Parameters:
16
+ - [`sort_by`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#sort_by) has been added as query parameter to [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) in [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
17
+
18
+
19
+ ### New Enums:
20
+ - `available`, `exhausted`, `scheduled`, and `in_grace_period` have been added as new values enum `Status`.
21
+ - `subscription_created`, `subscription_changed`, `top_up`, `promotional_grants`, and `rollover` have been added as new values to enum attribute [`grant_source`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#grant_source) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
22
+ - `provisioned` and `overdraft` have been added as new values to enum attribute [`account_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#account_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
23
+ - `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#unit_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
24
+ - `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_account_balances/ledger-account-balance-object#unit_type) in [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances).
25
+ - `allocation`, `capture`, `authorize`, `release_authorization`, `capture_authorization`, `expiry`, `void`, `rollover`, and `adjustment` have been added as new values to enum attribute [`type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
26
+ - `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#unit_type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
27
+ - `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.asc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
28
+ - `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.desc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
29
+ - `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.is` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
30
+ - `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.in` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
31
+ - `created_at` has been added as a new value to enum query parameter `sort_by.asc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
32
+ - `created_at` has been added as a new value to enum query parameter `sort_by.desc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
33
+ - `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.asc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
34
+ - `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.desc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
35
+
36
+
37
+
1
38
  ### v2.72.0 (2026-06-08)
2
39
  * * *
3
40
  ### New Attributes:
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- chargebee (2.72.0)
4
+ chargebee (2.73.0)
5
5
  cgi (>= 0.1.0, < 1.0.0)
6
6
 
7
7
  GEM
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.72.0
1
+ 2.73.0
data/chargebee.gemspec CHANGED
@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
4
4
  s.rubygems_version = '1.3.5'
5
5
  s.required_ruby_version = '>= 1.9.3'
6
6
  s.name = 'chargebee'
7
- s.version = '2.72.0'
8
- s.date = '2026-06-08'
7
+ s.version = '2.73.0'
8
+ s.date = '2026-06-12'
9
9
  s.summary = "Ruby client for Chargebee API."
10
10
  s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
11
11
  s.metadata = {
@@ -81,6 +81,7 @@ Gem::Specification.new do |s|
81
81
  lib/chargebee/models/filter_condition.rb
82
82
  lib/chargebee/models/gateway_error_detail.rb
83
83
  lib/chargebee/models/gift.rb
84
+ lib/chargebee/models/grant_block.rb
84
85
  lib/chargebee/models/hierarchy.rb
85
86
  lib/chargebee/models/hosted_page.rb
86
87
  lib/chargebee/models/impacted_customer.rb
@@ -94,6 +95,8 @@ Gem::Specification.new do |s|
94
95
  lib/chargebee/models/item_entitlement.rb
95
96
  lib/chargebee/models/item_family.rb
96
97
  lib/chargebee/models/item_price.rb
98
+ lib/chargebee/models/ledger_account_balance.rb
99
+ lib/chargebee/models/ledger_operation.rb
97
100
  lib/chargebee/models/metadata.rb
98
101
  lib/chargebee/models/model.rb
99
102
  lib/chargebee/models/non_subscription.rb
@@ -120,6 +123,7 @@ Gem::Specification.new do |s|
120
123
  lib/chargebee/models/price_variant.rb
121
124
  lib/chargebee/models/pricing_page_session.rb
122
125
  lib/chargebee/models/promotional_credit.rb
126
+ lib/chargebee/models/promotional_grant.rb
123
127
  lib/chargebee/models/purchase.rb
124
128
  lib/chargebee/models/quote.rb
125
129
  lib/chargebee/models/quote_entitlement.rb
@@ -61,7 +61,7 @@ module ChargeBee
61
61
  :status, :vat_number, :date, :price_type, :currency_code, :total, :amount_allocated, :amount_refunded,
62
62
  :amount_available, :refunded_at, :voided_at, :generated_at, :resource_version, :updated_at,
63
63
  :channel, :line_items_next_offset, :sub_total, :sub_total_in_local_currency, :total_in_local_currency,
64
- :local_currency_code, :round_off_amount, :fractional_correction, :line_items, :line_item_tiers,
64
+ :local_currency_code, :round_off_amount, :fractional_correction, :notes, :line_items, :line_item_tiers,
65
65
  :line_item_discounts, :line_item_taxes, :line_item_addresses, :discounts, :taxes, :tax_origin,
66
66
  :linked_refunds, :allocations, :deleted, :tax_category, :local_currency_exchange_rate, :create_reason_code,
67
67
  :vat_number_prefix, :business_entity_id, :shipping_address, :billing_address, :einvoice, :site_details_at_creation
@@ -0,0 +1,19 @@
1
+ module ChargeBee
2
+ class GrantBlock < Model
3
+
4
+ attr_accessor :id, :granted_amount, :effective_from, :expires_at, :balance, :hold_amount, :used_amount,
5
+ :expired_amount, :rolled_over_amount, :voided_amount, :origin_grant_block_id, :status, :metadata,
6
+ :grant_source, :created_at, :account_type, :unit_id, :unit_type
7
+
8
+ # OPERATIONS
9
+ #-----------
10
+
11
+ def self.list_grant_blocks(params, env=nil, headers={})
12
+ jsonKeys = {
13
+ }
14
+ options = {}
15
+ Request.send('get', uri_path("grant_blocks"), params, env, headers,nil, false, jsonKeys, options)
16
+ end
17
+
18
+ end # ~GrantBlock
19
+ end # ~ChargeBee
@@ -2,7 +2,7 @@ module ChargeBee
2
2
  class HostedPage < Model
3
3
 
4
4
  attr_accessor :id, :type, :url, :state, :failure_reason, :pass_thru_content, :embed, :created_at,
5
- :expires_at, :updated_at, :resource_version, :checkout_info, :business_entity_id
5
+ :expires_at, :layout, :updated_at, :resource_version, :checkout_info, :business_entity_id
6
6
 
7
7
  class Content < Result
8
8
  end
@@ -82,6 +82,7 @@ module ChargeBee
82
82
  Request.send('post', uri_path("hosted_pages","update_card"), params, env, headers,nil, false, jsonKeys, options)
83
83
  end
84
84
 
85
+ # @deprecated This method is deprecated and will be removed in a future version.
85
86
  def self.update_payment_method(params, env=nil, headers={})
86
87
  jsonKeys = {
87
88
  }
@@ -0,0 +1,25 @@
1
+ module ChargeBee
2
+ class LedgerAccountBalance < Model
3
+
4
+ class ProvisionedBalance < Model
5
+ attr_accessor :total_balance, :usable_balance, :hold_amount
6
+ end
7
+
8
+ class OverdraftBalance < Model
9
+ attr_accessor :is_unlimited, :limit, :total_balance, :usable_balance, :used_amount, :hold_amount
10
+ end
11
+
12
+ attr_accessor :subscription_id, :unit_id, :unit_type, :modified_at, :provisioned_balance, :overdraft_balance
13
+
14
+ # OPERATIONS
15
+ #-----------
16
+
17
+ def self.list_ledger_account_balances(params, env=nil, headers={})
18
+ jsonKeys = {
19
+ }
20
+ options = {}
21
+ Request.send('get', uri_path("ledger_account_balances"), params, env, headers,nil, false, jsonKeys, options)
22
+ end
23
+
24
+ end # ~LedgerAccountBalance
25
+ end # ~ChargeBee
@@ -0,0 +1,59 @@
1
+ module ChargeBee
2
+ class LedgerOperation < Model
3
+
4
+ attr_accessor :id, :type, :amount, :start_balance, :end_balance, :provisioned_start_balance,
5
+ :provisioned_end_balance, :overdraft_start_balance, :overdraft_end_balance, :parent_ledger_operation_id,
6
+ :ledger_operation_timestamp, :auto_release_timestamp, :metadata, :created_at, :modified_at,
7
+ :subscription_id, :unit_id, :unit_type
8
+
9
+ # OPERATIONS
10
+ #-----------
11
+
12
+ def self.retrieve_ledger_operation(id, env=nil, headers={})
13
+ jsonKeys = {
14
+ }
15
+ options = {}
16
+ Request.send('get', uri_path("ledger_operations",id.to_s), {}, env, headers,nil, false, jsonKeys, options)
17
+ end
18
+
19
+ def self.list_ledger_operations(params, env=nil, headers={})
20
+ jsonKeys = {
21
+ }
22
+ options = {}
23
+ Request.send('get', uri_path("ledger_operations"), params, env, headers,nil, false, jsonKeys, options)
24
+ end
25
+
26
+ def self.capture(params, env=nil, headers={})
27
+ jsonKeys = {
28
+ :metadata => 0,
29
+ }
30
+ options = {}
31
+ Request.send('post', uri_path("ledger_operations","capture"), params, env, headers,nil, true, jsonKeys, options)
32
+ end
33
+
34
+ def self.authorize(params, env=nil, headers={})
35
+ jsonKeys = {
36
+ :metadata => 0,
37
+ }
38
+ options = {}
39
+ Request.send('post', uri_path("ledger_operations","authorize"), params, env, headers,nil, true, jsonKeys, options)
40
+ end
41
+
42
+ def self.capture_authorization(params, env=nil, headers={})
43
+ jsonKeys = {
44
+ :metadata => 0,
45
+ }
46
+ options = {}
47
+ Request.send('post', uri_path("ledger_operations","capture_authorization"), params, env, headers,nil, true, jsonKeys, options)
48
+ end
49
+
50
+ def self.release_authorization(params, env=nil, headers={})
51
+ jsonKeys = {
52
+ :metadata => 0,
53
+ }
54
+ options = {}
55
+ Request.send('post', uri_path("ledger_operations","release_authorization"), params, env, headers,nil, true, jsonKeys, options)
56
+ end
57
+
58
+ end # ~LedgerOperation
59
+ end # ~ChargeBee
@@ -22,7 +22,7 @@ module ChargeBee
22
22
  jsonKeys = {
23
23
  }
24
24
  options = {}
25
- Request.send('get', uri_path("offer_fulfillments",id.to_s), {}, env, headers, "grow", true, jsonKeys, options)
25
+ Request.send('get', uri_path("offer_fulfillments",id.to_s), {}, env, headers, "grow", false, jsonKeys, options)
26
26
  end
27
27
 
28
28
  def self.offer_fulfillments_update(id, params, env=nil, headers={})
@@ -0,0 +1,20 @@
1
+ module ChargeBee
2
+ class PromotionalGrant < Model
3
+
4
+ attr_accessor :subscription_id, :unit_id, :amount, :expires_at, :metadata
5
+
6
+ # OPERATIONS
7
+ #-----------
8
+
9
+ def self.promotional_grants(params, env=nil, headers={})
10
+ jsonKeys = {
11
+ :metadata => 0,
12
+ }
13
+ options = {
14
+ :isIdempotent => true
15
+ }
16
+ Request.send('post', uri_path("promotional_grants"), params, env, headers,nil, true, jsonKeys, options)
17
+ end
18
+
19
+ end # ~PromotionalGrant
20
+ end # ~ChargeBee
@@ -593,6 +593,27 @@ module ChargeBee
593
593
  return alert_status;
594
594
  end
595
595
 
596
+ def ledger_account_balance()
597
+ ledger_account_balance = get(:ledger_account_balance, LedgerAccountBalance,
598
+ {:provisioned_balance => LedgerAccountBalance::ProvisionedBalance, :overdraft_balance => LedgerAccountBalance::OverdraftBalance});
599
+ return ledger_account_balance;
600
+ end
601
+
602
+ def ledger_operation()
603
+ ledger_operation = get(:ledger_operation, LedgerOperation);
604
+ return ledger_operation;
605
+ end
606
+
607
+ def grant_block()
608
+ grant_block = get(:grant_block, GrantBlock);
609
+ return grant_block;
610
+ end
611
+
612
+ def promotional_grant()
613
+ promotional_grant = get(:promotional_grant, PromotionalGrant);
614
+ return promotional_grant;
615
+ end
616
+
596
617
  def impacted_customer()
597
618
  impacted_customer = get(:impacted_customer, ImpactedCustomer,
598
619
  {:download => ImpactedCustomer::Download});
@@ -669,6 +690,18 @@ module ChargeBee
669
690
  return personalized_offers;
670
691
  end
671
692
 
693
+ def ledger_operations()
694
+ ledger_operations = get_list(:ledger_operations, LedgerOperation,
695
+ {});
696
+ return ledger_operations;
697
+ end
698
+
699
+ def grant_blocks()
700
+ grant_blocks = get_list(:grant_blocks, GrantBlock,
701
+ {});
702
+ return grant_blocks;
703
+ end
704
+
672
705
 
673
706
  def to_s(*args)
674
707
  JSON.pretty_generate(@response)
data/lib/chargebee.rb CHANGED
@@ -100,7 +100,7 @@ require File.dirname(__FILE__) + '/chargebee/models/einvoice'
100
100
 
101
101
  module ChargeBee
102
102
 
103
- VERSION = '2.72.0'
103
+ VERSION = '2.73.0'
104
104
 
105
105
  @@default_env = nil
106
106
  @@verify_ca_certs = true
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chargebee
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.72.0
4
+ version: 2.73.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rajaraman S
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2026-06-08 00:00:00.000000000 Z
12
+ date: 2026-06-12 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: cgi
@@ -122,6 +122,7 @@ files:
122
122
  - lib/chargebee/models/filter_condition.rb
123
123
  - lib/chargebee/models/gateway_error_detail.rb
124
124
  - lib/chargebee/models/gift.rb
125
+ - lib/chargebee/models/grant_block.rb
125
126
  - lib/chargebee/models/hierarchy.rb
126
127
  - lib/chargebee/models/hosted_page.rb
127
128
  - lib/chargebee/models/impacted_customer.rb
@@ -135,6 +136,8 @@ files:
135
136
  - lib/chargebee/models/item_entitlement.rb
136
137
  - lib/chargebee/models/item_family.rb
137
138
  - lib/chargebee/models/item_price.rb
139
+ - lib/chargebee/models/ledger_account_balance.rb
140
+ - lib/chargebee/models/ledger_operation.rb
138
141
  - lib/chargebee/models/metadata.rb
139
142
  - lib/chargebee/models/model.rb
140
143
  - lib/chargebee/models/non_subscription.rb
@@ -161,6 +164,7 @@ files:
161
164
  - lib/chargebee/models/price_variant.rb
162
165
  - lib/chargebee/models/pricing_page_session.rb
163
166
  - lib/chargebee/models/promotional_credit.rb
167
+ - lib/chargebee/models/promotional_grant.rb
164
168
  - lib/chargebee/models/purchase.rb
165
169
  - lib/chargebee/models/quote.rb
166
170
  - lib/chargebee/models/quote_entitlement.rb