Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
### v2.79.0 (2026-08-12)
* * *
### New Resources:
- [`GatewayPaymentMethodToken`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens) has been added.
- [`OmnichannelSubscriptionItemMetric`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_item_metrics) has been added.
- [`VaultedPaymentMethod`](https://apidocs.chargebee.com/docs/api/vaulted_payment_methods) has been added.


### New Actions:
- [`update_credit_note_details`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details) has been added to [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
- [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) has been added to [`Export`](https://apidocs.chargebee.com/docs/api/exports).
- [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) has been added to [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).


### New Attributes:
- [`vault_token`](https://apidocs.chargebee.com/docs/api/payment_sources/payment-source-object#vault_token) has been added to [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).


### New Parameters:
- [`updated_at.between`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at_between) 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).
- [`updated_at.on`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at_on) 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).
- [`purchased_at.between`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at_between) 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).
- [`purchased_at.on`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at_on) 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).
- [`limit`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#limit) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
- [`offset`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#offset) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
- [`include_deleted`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source#include_deleted) has been added as query parameter to [`list_gateway_payment_method_tokens_for_a_payment_source`](https://apidocs.chargebee.com/docs/api/payment_sources/list-gateway-payment-method-tokens-for-a-payment-source) in [`PaymentSource`](https://apidocs.chargebee.com/docs/api/payment_sources).
- [`comment`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details#comment) has been added as request body parameter to [`update_credit_note_details`](https://apidocs.chargebee.com/docs/api/credit_notes/update-credit-note-details) in [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
- [`ramp`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps#ramp) has been added as request body parameter to [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) in [`Export`](https://apidocs.chargebee.com/docs/api/exports).
- [`export_type`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps#export_type) has been added as request body parameter to [`export_subscription_ramps`](https://apidocs.chargebee.com/docs/api/exports/export-subscription-ramps) in [`Export`](https://apidocs.chargebee.com/docs/api/exports).
- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_items_description) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items#subscription_items_description) has been added as request body parameter to [`edit_update_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_items_description) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
- [`subscription_items.description`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items#subscription_items_description) has been added as request body parameter to [`create_a_quote_for_update_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).


### New Events:
- [`vault_token_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_updated) has been added.
- [`vault_token_deleted`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_deleted) has been added.
- [`omnichannel_subscription_item_mrr_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_mrr_updated) has been added.
- [`vault_token_created`](https://apidocs.chargebee.com/docs/api/events/webhook/vault_token_created) has been added.


### New Enums:
- `omnichannel_subscription_item_metric` has been added as a new value enum `EntityType`.
- `omnichannel_subscription_item_mrr_updated`, `vault_token_created`, `vault_token_updated`, and `vault_token_deleted` have been added as new values enum `EventType`.
- `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`, `gocardless`, `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`, `deutsche_bank`, `ezidebit`, `twikey`, `tempus`, `moyasar`, `payway`, and `not_applicable` have been added as new values enum `GatewayName`.
- `active`, `inactive`, and `pending_verification` have been added as new values to enum attribute [`status`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens/gateway-payment-method-token-object#status) in [`GatewayPaymentMethodToken`](https://apidocs.chargebee.com/docs/api/gateway_payment_method_tokens).
- `payment_method_helper`, `card_components`, `checkout`, `collect_now`, `portal`, and `payment_components` have been added as new values to enum attribute [`payment_intent_metadata.source`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_intent_metadata_source) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).



### v2.78.0 (2026-07-30)
* * *
### New Resources:
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
chargebee (2.78.0)
chargebee (2.79.0)
cgi (>= 0.1.0, < 1.0.0)

GEM
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.78.0
2.79.0
7 changes: 5 additions & 2 deletions chargebee.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Gem::Specification.new do |s|
s.rubygems_version = '1.3.5'
s.required_ruby_version = '>= 1.9.3'
s.name = 'chargebee'
s.version = '2.78.0'
s.date = '2026-07-30'
s.version = '2.79.0'
s.date = '2026-08-12'
s.summary = "Ruby client for Chargebee API."
s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
s.metadata = {
Expand Down Expand Up @@ -84,6 +84,7 @@ Gem::Specification.new do |s|
lib/chargebee/models/feature.rb
lib/chargebee/models/filter_condition.rb
lib/chargebee/models/gateway_error_detail.rb
lib/chargebee/models/gateway_payment_method_token.rb
lib/chargebee/models/gift.rb
lib/chargebee/models/grant_block.rb
lib/chargebee/models/hierarchy.rb
Expand Down Expand Up @@ -113,6 +114,7 @@ Gem::Specification.new do |s|
lib/chargebee/models/omnichannel_one_time_order_item.rb
lib/chargebee/models/omnichannel_subscription.rb
lib/chargebee/models/omnichannel_subscription_item.rb
lib/chargebee/models/omnichannel_subscription_item_metric.rb
lib/chargebee/models/omnichannel_subscription_item_offer.rb
lib/chargebee/models/omnichannel_subscription_item_scheduled_change.rb
lib/chargebee/models/omnichannel_transaction.rb
Expand Down Expand Up @@ -160,6 +162,7 @@ Gem::Specification.new do |s|
lib/chargebee/models/usage_event.rb
lib/chargebee/models/usage_file.rb
lib/chargebee/models/usage_summary.rb
lib/chargebee/models/vaulted_payment_method.rb
lib/chargebee/models/virtual_bank_account.rb
lib/chargebee/models/webhook_endpoint.rb
lib/chargebee/native_request.rb
Expand Down
5 changes: 4 additions & 1 deletion lib/chargebee.rb
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
require File.dirname(__FILE__) + '/chargebee/models/feature'
require File.dirname(__FILE__) + '/chargebee/models/filter_condition'
require File.dirname(__FILE__) + '/chargebee/models/gateway_error_detail'
require File.dirname(__FILE__) + '/chargebee/models/gateway_payment_method_token'
require File.dirname(__FILE__) + '/chargebee/models/gift'
require File.dirname(__FILE__) + '/chargebee/models/grant_block'
require File.dirname(__FILE__) + '/chargebee/models/hierarchy'
Expand Down Expand Up @@ -85,6 +86,7 @@
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_one_time_order_item'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item_metric'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item_offer'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item_scheduled_change'
require File.dirname(__FILE__) + '/chargebee/models/omnichannel_transaction'
Expand Down Expand Up @@ -131,12 +133,13 @@
require File.dirname(__FILE__) + '/chargebee/models/usage_event'
require File.dirname(__FILE__) + '/chargebee/models/usage_file'
require File.dirname(__FILE__) + '/chargebee/models/usage_summary'
require File.dirname(__FILE__) + '/chargebee/models/vaulted_payment_method'
require File.dirname(__FILE__) + '/chargebee/models/virtual_bank_account'
require File.dirname(__FILE__) + '/chargebee/models/webhook_endpoint'

module ChargeBee

VERSION = '2.78.0'
VERSION = '2.79.0'

@@default_env = nil
@@verify_ca_certs = true
Expand Down
9 changes: 9 additions & 0 deletions lib/chargebee/models/credit_note.rb
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,15 @@ def self.delete(id, params={}, env=nil, headers={})
Request.send('post', uri_path("credit_notes",id.to_s,"delete"), params, env, headers,nil, false, jsonKeys, options, "creditNote", "delete")
end

def self.update(id, params={}, env=nil, headers={})
jsonKeys = {
}
options = {
:isIdempotent => true
}
Request.send('post', uri_path("credit_notes",id.to_s,"update"), params, env, headers,nil, false, jsonKeys, options, "creditNote", "update")
end

def self.remove_tax_withheld_refund(id, params, env=nil, headers={})
jsonKeys = {
}
Expand Down
9 changes: 9 additions & 0 deletions lib/chargebee/models/export.rb
Original file line number Diff line number Diff line change
Expand Up @@ -196,5 +196,14 @@ def self.price_variants(params={}, env=nil, headers={})
Request.send('post', uri_path("exports","price_variants"), params, env, headers,nil, false, jsonKeys, options, "export", "priceVariants")
end

def self.ramps(params={}, env=nil, headers={})
jsonKeys = {
}
options = {
:isIdempotent => true
}
Request.send('post', uri_path("exports","ramps"), params, env, headers,nil, false, jsonKeys, options, "export", "ramps")
end

end # ~Export
end # ~ChargeBee
11 changes: 11 additions & 0 deletions lib/chargebee/models/gateway_payment_method_token.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
module ChargeBee
class GatewayPaymentMethodToken < Model

attr_accessor :id, :gateway_account_id, :gateway_name, :gateway_customer_id, :gateway_token,
:status, :created_at, :updated_at

# OPERATIONS
#-----------

end # ~GatewayPaymentMethodToken
end # ~ChargeBee
12 changes: 12 additions & 0 deletions lib/chargebee/models/omnichannel_subscription_item_metric.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
module ChargeBee
class OmnichannelSubscriptionItemMetric < Model

attr_accessor :customer_id, :omnichannel_subscription_id, :omnichannel_subscription_item_id,
:item_id_at_source, :mrr_currency, :mrr_units, :mrr_nanos, :effective_from, :calculated_at,
:created_at, :resource_version

# OPERATIONS
#-----------

end # ~OmnichannelSubscriptionItemMetric
end # ~ChargeBee
9 changes: 8 additions & 1 deletion lib/chargebee/models/payment_source.rb
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Mandate < Model
attr_accessor :id, :resource_version, :updated_at, :created_at, :customer_id, :type, :reference_id,
:status, :gateway, :gateway_account_id, :ip_address, :issuing_country, :card, :bank_account,
:boleto, :billing_address, :amazon_payment, :upi, :paypal, :venmo, :klarna_pay_now, :mandates,
:deleted, :business_entity_id
:vault_token, :deleted, :business_entity_id

# OPERATIONS
#-----------
Expand Down Expand Up @@ -148,6 +148,13 @@ def self.verify_bank_account(id, params, env=nil, headers={})
Request.send('post', uri_path("payment_sources",id.to_s,"verify_bank_account"), params, env, headers,nil, false, jsonKeys, options, "paymentSource", "verifyBankAccount")
end

def self.list_gateway_tokens_for_payment_source(id, params={}, env=nil, headers={})
jsonKeys = {
}
options = {}
Request.send('get', uri_path("payment_sources",id.to_s,"gateway_payment_method_tokens"), params, env, headers,nil, false, jsonKeys, options, "paymentSource", "listGatewayTokensForPaymentSource")
end

def self.retrieve(id, env=nil, headers={})
jsonKeys = {
}
Expand Down
2 changes: 1 addition & 1 deletion lib/chargebee/models/quoted_ramp.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module ChargeBee
class QuotedRamp < Model

class LineItem < Model
attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :start_date, :end_date, :ramp_tier_id, :discount_per_billing_cycle, :discount_per_billing_cycle_in_decimal, :item_level_discount_per_billing_cycle, :item_level_discount_per_billing_cycle_in_decimal, :amount_per_billing_cycle, :amount_per_billing_cycle_in_decimal, :net_amount_per_billing_cycle, :net_amount_per_billing_cycle_in_decimal
attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :start_date, :end_date, :ramp_tier_id, :discount_per_billing_cycle, :discount_per_billing_cycle_in_decimal, :item_level_discount_per_billing_cycle, :item_level_discount_per_billing_cycle_in_decimal, :amount_per_billing_cycle, :amount_per_billing_cycle_in_decimal, :net_amount_per_billing_cycle, :net_amount_per_billing_cycle_in_decimal, :description
end

class Discount < Model
Expand Down
17 changes: 17 additions & 0 deletions lib/chargebee/models/vaulted_payment_method.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
module ChargeBee
class VaultedPaymentMethod < Model

attr_accessor :id, :customer_id, :credit_card_id, :created_at, :modified_at

# OPERATIONS
#-----------

def self.retrieve(id, env=nil, headers={})
jsonKeys = {
}
options = {}
Request.send('get', uri_path("vaulted_payment_methods",id.to_s), {}, env, headers,nil, false, jsonKeys, options, "vaultedPaymentMethod", "retrieve")
end

end # ~VaultedPaymentMethod
end # ~ChargeBee
15 changes: 15 additions & 0 deletions lib/chargebee/result.rb
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,21 @@ def payment_source()
return payment_source;
end

def gateway_payment_method_token()
gateway_payment_method_token = get(:gateway_payment_method_token, GatewayPaymentMethodToken);
return gateway_payment_method_token;
end

def third_party_payment_method()
third_party_payment_method = get(:third_party_payment_method, ThirdPartyPaymentMethod);
return third_party_payment_method;
end

def vaulted_payment_method()
vaulted_payment_method = get(:vaulted_payment_method, VaultedPaymentMethod);
return vaulted_payment_method;
end

def virtual_bank_account()
virtual_bank_account = get(:virtual_bank_account, VirtualBankAccount);
return virtual_bank_account;
Expand Down Expand Up @@ -499,6 +509,11 @@ def omnichannel_subscription_item_scheduled_change()
return omnichannel_subscription_item_scheduled_change;
end

def omnichannel_subscription_item_metric()
omnichannel_subscription_item_metric = get(:omnichannel_subscription_item_metric, OmnichannelSubscriptionItemMetric);
return omnichannel_subscription_item_metric;
end

def omnichannel_subscription()
omnichannel_subscription = get(:omnichannel_subscription, OmnichannelSubscription, {},
{:omnichannel_subscription_items => OmnichannelSubscriptionItem, :initial_purchase_transaction => OmnichannelTransaction});
Expand Down
Loading