Class: ChargeBee::Subscription
- Defined in:
- lib/chargebee/models/subscription.rb
Defined Under Namespace
Classes: Addon, BillingOverride, ChargedEventBasedAddon, ChargedItem, ContractTerm, Coupon, Discount, EventBasedAddon, ItemTier, ReferralInfo, ShippingAddress, SubscriptionItem
Instance Attribute Summary collapse
-
#activated_at ⇒ Object
Returns the value of attribute activated_at.
-
#active_id ⇒ Object
Returns the value of attribute active_id.
-
#addons ⇒ Object
Returns the value of attribute addons.
-
#affiliate_token ⇒ Object
Returns the value of attribute affiliate_token.
-
#arr ⇒ Object
Returns the value of attribute arr.
-
#auto_close_invoices ⇒ Object
Returns the value of attribute auto_close_invoices.
-
#auto_collection ⇒ Object
Returns the value of attribute auto_collection.
-
#base_currency_code ⇒ Object
Returns the value of attribute base_currency_code.
-
#billing_override ⇒ Object
Returns the value of attribute billing_override.
-
#billing_period ⇒ Object
Returns the value of attribute billing_period.
-
#billing_period_unit ⇒ Object
Returns the value of attribute billing_period_unit.
-
#business_entity_id ⇒ Object
Returns the value of attribute business_entity_id.
-
#cancel_reason ⇒ Object
Returns the value of attribute cancel_reason.
-
#cancel_reason_code ⇒ Object
Returns the value of attribute cancel_reason_code.
-
#cancel_schedule_created_at ⇒ Object
Returns the value of attribute cancel_schedule_created_at.
-
#cancelled_at ⇒ Object
Returns the value of attribute cancelled_at.
-
#changes_scheduled_at ⇒ Object
Returns the value of attribute changes_scheduled_at.
-
#channel ⇒ Object
Returns the value of attribute channel.
-
#charged_event_based_addons ⇒ Object
Returns the value of attribute charged_event_based_addons.
-
#charged_items ⇒ Object
Returns the value of attribute charged_items.
-
#contract_term ⇒ Object
Returns the value of attribute contract_term.
-
#contract_term_billing_cycle_on_renewal ⇒ Object
Returns the value of attribute contract_term_billing_cycle_on_renewal.
-
#coupon ⇒ Object
Returns the value of attribute coupon.
-
#coupons ⇒ Object
Returns the value of attribute coupons.
-
#create_pending_invoices ⇒ Object
Returns the value of attribute create_pending_invoices.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#created_from_ip ⇒ Object
Returns the value of attribute created_from_ip.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#current_term_end ⇒ Object
Returns the value of attribute current_term_end.
-
#current_term_start ⇒ Object
Returns the value of attribute current_term_start.
-
#customer_id ⇒ Object
Returns the value of attribute customer_id.
-
#deleted ⇒ Object
Returns the value of attribute deleted.
-
#discounts ⇒ Object
Returns the value of attribute discounts.
-
#due_invoices_count ⇒ Object
Returns the value of attribute due_invoices_count.
-
#due_since ⇒ Object
Returns the value of attribute due_since.
-
#event_based_addons ⇒ Object
Returns the value of attribute event_based_addons.
-
#exchange_rate ⇒ Object
Returns the value of attribute exchange_rate.
-
#free_period ⇒ Object
Returns the value of attribute free_period.
-
#free_period_unit ⇒ Object
Returns the value of attribute free_period_unit.
-
#gift_id ⇒ Object
Returns the value of attribute gift_id.
-
#has_scheduled_advance_invoices ⇒ Object
Returns the value of attribute has_scheduled_advance_invoices.
-
#has_scheduled_changes ⇒ Object
Returns the value of attribute has_scheduled_changes.
-
#id ⇒ Object
Returns the value of attribute id.
-
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
-
#item_tiers ⇒ Object
Returns the value of attribute item_tiers.
-
#meta_data ⇒ Object
Returns the value of attribute meta_data.
-
#metadata ⇒ Object
Returns the value of attribute metadata.
-
#mrr ⇒ Object
Returns the value of attribute mrr.
-
#net_term_days ⇒ Object
Returns the value of attribute net_term_days.
-
#next_billing_at ⇒ Object
Returns the value of attribute next_billing_at.
-
#offline_payment_method ⇒ Object
Returns the value of attribute offline_payment_method.
-
#override_relationship ⇒ Object
Returns the value of attribute override_relationship.
-
#pause_date ⇒ Object
Returns the value of attribute pause_date.
-
#payment_source_id ⇒ Object
Returns the value of attribute payment_source_id.
-
#plan_amount ⇒ Object
Returns the value of attribute plan_amount.
-
#plan_amount_in_decimal ⇒ Object
Returns the value of attribute plan_amount_in_decimal.
-
#plan_free_quantity ⇒ Object
Returns the value of attribute plan_free_quantity.
-
#plan_free_quantity_in_decimal ⇒ Object
Returns the value of attribute plan_free_quantity_in_decimal.
-
#plan_id ⇒ Object
Returns the value of attribute plan_id.
-
#plan_quantity ⇒ Object
Returns the value of attribute plan_quantity.
-
#plan_quantity_in_decimal ⇒ Object
Returns the value of attribute plan_quantity_in_decimal.
-
#plan_unit_price ⇒ Object
Returns the value of attribute plan_unit_price.
-
#plan_unit_price_in_decimal ⇒ Object
Returns the value of attribute plan_unit_price_in_decimal.
-
#po_number ⇒ Object
Returns the value of attribute po_number.
-
#referral_info ⇒ Object
Returns the value of attribute referral_info.
-
#remaining_billing_cycles ⇒ Object
Returns the value of attribute remaining_billing_cycles.
-
#resource_version ⇒ Object
Returns the value of attribute resource_version.
-
#resume_date ⇒ Object
Returns the value of attribute resume_date.
-
#setup_fee ⇒ Object
Returns the value of attribute setup_fee.
-
#shipping_address ⇒ Object
Returns the value of attribute shipping_address.
-
#start_date ⇒ Object
Returns the value of attribute start_date.
-
#started_at ⇒ Object
Returns the value of attribute started_at.
-
#status ⇒ Object
Returns the value of attribute status.
-
#subscription_items ⇒ Object
Returns the value of attribute subscription_items.
-
#total_dues ⇒ Object
Returns the value of attribute total_dues.
-
#trial_end ⇒ Object
Returns the value of attribute trial_end.
-
#trial_end_action ⇒ Object
Returns the value of attribute trial_end_action.
-
#trial_start ⇒ Object
Returns the value of attribute trial_start.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
Class Method Summary collapse
- .add_charge_at_term_end(id, params, env = nil, headers = {}) ⇒ Object
- .cancel(id, params = {}, env = nil, headers = {}) ⇒ Object
- .cancel_for_items(id, params = {}, env = nil, headers = {}) ⇒ Object
- .change_term_end(id, params, env = nil, headers = {}) ⇒ Object
- .charge_addon_at_term_end(id, params, env = nil, headers = {}) ⇒ Object
- .charge_future_renewals(id, params = {}, env = nil, headers = {}) ⇒ Object
- .contract_terms_for_subscription(id, params = {}, env = nil, headers = {}) ⇒ Object
-
.create(params, env = nil, headers = {}) ⇒ Object
OPERATIONS ———–.
- .create_for_customer(id, params, env = nil, headers = {}) ⇒ Object
- .create_with_items(id, params, env = nil, headers = {}) ⇒ Object
- .delete(id, env = nil, headers = {}) ⇒ Object
- .edit_advance_invoice_schedule(id, params = {}, env = nil, headers = {}) ⇒ Object
- .import_contract_term(id, params = {}, env = nil, headers = {}) ⇒ Object
- .import_for_customer(id, params, env = nil, headers = {}) ⇒ Object
- .import_for_items(id, params, env = nil, headers = {}) ⇒ Object
- .import_subscription(params, env = nil, headers = {}) ⇒ Object
- .import_unbilled_charges(id, params, env = nil, headers = {}) ⇒ Object
- .list(params = {}, env = nil, headers = {}) ⇒ Object
- .list_discounts(id, params = {}, env = nil, headers = {}) ⇒ Object
- .move(id, params, env = nil, headers = {}) ⇒ Object
- .override_billing_profile(id, params = {}, env = nil, headers = {}) ⇒ Object
- .pause(id, params = {}, env = nil, headers = {}) ⇒ Object
- .reactivate(id, params = {}, env = nil, headers = {}) ⇒ Object
- .regenerate_invoice(id, params = {}, env = nil, headers = {}) ⇒ Object
- .remove_advance_invoice_schedule(id, params = {}, env = nil, headers = {}) ⇒ Object
- .remove_coupons(id, params = {}, env = nil, headers = {}) ⇒ Object
- .remove_scheduled_cancellation(id, params = {}, env = nil, headers = {}) ⇒ Object
- .remove_scheduled_changes(id, env = nil, headers = {}) ⇒ Object
- .remove_scheduled_pause(id, env = nil, headers = {}) ⇒ Object
- .remove_scheduled_resumption(id, env = nil, headers = {}) ⇒ Object
- .resume(id, params = {}, env = nil, headers = {}) ⇒ Object
- .retrieve(id, env = nil, headers = {}) ⇒ Object
- .retrieve_advance_invoice_schedule(id, env = nil, headers = {}) ⇒ Object
- .retrieve_with_scheduled_changes(id, env = nil, headers = {}) ⇒ Object
- .subscriptions_for_customer(id, params = {}, env = nil, headers = {}) ⇒ Object
- .update(id, params = {}, env = nil, headers = {}) ⇒ Object
- .update_for_items(id, params, env = nil, headers = {}) ⇒ Object
Methods inherited from Model
construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #replace_white_space_with_underscore, #to_s, uri_path
Constructor Details
This class inherits a constructor from ChargeBee::Model
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class ChargeBee::Model
Instance Attribute Details
#activated_at ⇒ Object
Returns the value of attribute activated_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def activated_at @activated_at end |
#active_id ⇒ Object
Returns the value of attribute active_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def active_id @active_id end |
#addons ⇒ Object
Returns the value of attribute addons.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def addons @addons end |
#affiliate_token ⇒ Object
Returns the value of attribute affiliate_token.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def affiliate_token @affiliate_token end |
#arr ⇒ Object
Returns the value of attribute arr.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def arr @arr end |
#auto_close_invoices ⇒ Object
Returns the value of attribute auto_close_invoices.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def auto_close_invoices @auto_close_invoices end |
#auto_collection ⇒ Object
Returns the value of attribute auto_collection.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def auto_collection @auto_collection end |
#base_currency_code ⇒ Object
Returns the value of attribute base_currency_code.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def base_currency_code @base_currency_code end |
#billing_override ⇒ Object
Returns the value of attribute billing_override.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def billing_override @billing_override end |
#billing_period ⇒ Object
Returns the value of attribute billing_period.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def billing_period @billing_period end |
#billing_period_unit ⇒ Object
Returns the value of attribute billing_period_unit.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def billing_period_unit @billing_period_unit end |
#business_entity_id ⇒ Object
Returns the value of attribute business_entity_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def business_entity_id @business_entity_id end |
#cancel_reason ⇒ Object
Returns the value of attribute cancel_reason.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def cancel_reason @cancel_reason end |
#cancel_reason_code ⇒ Object
Returns the value of attribute cancel_reason_code.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def cancel_reason_code @cancel_reason_code end |
#cancel_schedule_created_at ⇒ Object
Returns the value of attribute cancel_schedule_created_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def cancel_schedule_created_at @cancel_schedule_created_at end |
#cancelled_at ⇒ Object
Returns the value of attribute cancelled_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def cancelled_at @cancelled_at end |
#changes_scheduled_at ⇒ Object
Returns the value of attribute changes_scheduled_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def changes_scheduled_at @changes_scheduled_at end |
#channel ⇒ Object
Returns the value of attribute channel.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def channel @channel end |
#charged_event_based_addons ⇒ Object
Returns the value of attribute charged_event_based_addons.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def charged_event_based_addons @charged_event_based_addons end |
#charged_items ⇒ Object
Returns the value of attribute charged_items.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def charged_items @charged_items end |
#contract_term ⇒ Object
Returns the value of attribute contract_term.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def contract_term @contract_term end |
#contract_term_billing_cycle_on_renewal ⇒ Object
Returns the value of attribute contract_term_billing_cycle_on_renewal.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def contract_term_billing_cycle_on_renewal @contract_term_billing_cycle_on_renewal end |
#coupon ⇒ Object
Returns the value of attribute coupon.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def coupon @coupon end |
#coupons ⇒ Object
Returns the value of attribute coupons.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def coupons @coupons end |
#create_pending_invoices ⇒ Object
Returns the value of attribute create_pending_invoices.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def create_pending_invoices @create_pending_invoices end |
#created_at ⇒ Object
Returns the value of attribute created_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def created_at @created_at end |
#created_from_ip ⇒ Object
Returns the value of attribute created_from_ip.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def created_from_ip @created_from_ip end |
#currency_code ⇒ Object
Returns the value of attribute currency_code.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def currency_code @currency_code end |
#current_term_end ⇒ Object
Returns the value of attribute current_term_end.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def current_term_end @current_term_end end |
#current_term_start ⇒ Object
Returns the value of attribute current_term_start.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def current_term_start @current_term_start end |
#customer_id ⇒ Object
Returns the value of attribute customer_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def customer_id @customer_id end |
#deleted ⇒ Object
Returns the value of attribute deleted.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def deleted @deleted end |
#discounts ⇒ Object
Returns the value of attribute discounts.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def discounts @discounts end |
#due_invoices_count ⇒ Object
Returns the value of attribute due_invoices_count.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def due_invoices_count @due_invoices_count end |
#due_since ⇒ Object
Returns the value of attribute due_since.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def due_since @due_since end |
#event_based_addons ⇒ Object
Returns the value of attribute event_based_addons.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def event_based_addons @event_based_addons end |
#exchange_rate ⇒ Object
Returns the value of attribute exchange_rate.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def exchange_rate @exchange_rate end |
#free_period ⇒ Object
Returns the value of attribute free_period.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def free_period @free_period end |
#free_period_unit ⇒ Object
Returns the value of attribute free_period_unit.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def free_period_unit @free_period_unit end |
#gift_id ⇒ Object
Returns the value of attribute gift_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def gift_id @gift_id end |
#has_scheduled_advance_invoices ⇒ Object
Returns the value of attribute has_scheduled_advance_invoices.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def has_scheduled_advance_invoices @has_scheduled_advance_invoices end |
#has_scheduled_changes ⇒ Object
Returns the value of attribute has_scheduled_changes.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def has_scheduled_changes @has_scheduled_changes end |
#id ⇒ Object
Returns the value of attribute id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def id @id end |
#invoice_notes ⇒ Object
Returns the value of attribute invoice_notes.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def invoice_notes @invoice_notes end |
#item_tiers ⇒ Object
Returns the value of attribute item_tiers.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def item_tiers @item_tiers end |
#meta_data ⇒ Object
Returns the value of attribute meta_data.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def @meta_data end |
#metadata ⇒ Object
Returns the value of attribute metadata.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def @metadata end |
#mrr ⇒ Object
Returns the value of attribute mrr.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def mrr @mrr end |
#net_term_days ⇒ Object
Returns the value of attribute net_term_days.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def net_term_days @net_term_days end |
#next_billing_at ⇒ Object
Returns the value of attribute next_billing_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def next_billing_at @next_billing_at end |
#offline_payment_method ⇒ Object
Returns the value of attribute offline_payment_method.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def offline_payment_method @offline_payment_method end |
#override_relationship ⇒ Object
Returns the value of attribute override_relationship.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def override_relationship @override_relationship end |
#pause_date ⇒ Object
Returns the value of attribute pause_date.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def pause_date @pause_date end |
#payment_source_id ⇒ Object
Returns the value of attribute payment_source_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def payment_source_id @payment_source_id end |
#plan_amount ⇒ Object
Returns the value of attribute plan_amount.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_amount @plan_amount end |
#plan_amount_in_decimal ⇒ Object
Returns the value of attribute plan_amount_in_decimal.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_amount_in_decimal @plan_amount_in_decimal end |
#plan_free_quantity ⇒ Object
Returns the value of attribute plan_free_quantity.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_free_quantity @plan_free_quantity end |
#plan_free_quantity_in_decimal ⇒ Object
Returns the value of attribute plan_free_quantity_in_decimal.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_free_quantity_in_decimal @plan_free_quantity_in_decimal end |
#plan_id ⇒ Object
Returns the value of attribute plan_id.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_id @plan_id end |
#plan_quantity ⇒ Object
Returns the value of attribute plan_quantity.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_quantity @plan_quantity end |
#plan_quantity_in_decimal ⇒ Object
Returns the value of attribute plan_quantity_in_decimal.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_quantity_in_decimal @plan_quantity_in_decimal end |
#plan_unit_price ⇒ Object
Returns the value of attribute plan_unit_price.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_unit_price @plan_unit_price end |
#plan_unit_price_in_decimal ⇒ Object
Returns the value of attribute plan_unit_price_in_decimal.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def plan_unit_price_in_decimal @plan_unit_price_in_decimal end |
#po_number ⇒ Object
Returns the value of attribute po_number.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def po_number @po_number end |
#referral_info ⇒ Object
Returns the value of attribute referral_info.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def referral_info @referral_info end |
#remaining_billing_cycles ⇒ Object
Returns the value of attribute remaining_billing_cycles.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def remaining_billing_cycles @remaining_billing_cycles end |
#resource_version ⇒ Object
Returns the value of attribute resource_version.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def resource_version @resource_version end |
#resume_date ⇒ Object
Returns the value of attribute resume_date.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def resume_date @resume_date end |
#setup_fee ⇒ Object
Returns the value of attribute setup_fee.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def setup_fee @setup_fee end |
#shipping_address ⇒ Object
Returns the value of attribute shipping_address.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def shipping_address @shipping_address end |
#start_date ⇒ Object
Returns the value of attribute start_date.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def start_date @start_date end |
#started_at ⇒ Object
Returns the value of attribute started_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def started_at @started_at end |
#status ⇒ Object
Returns the value of attribute status.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def status @status end |
#subscription_items ⇒ Object
Returns the value of attribute subscription_items.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def subscription_items @subscription_items end |
#total_dues ⇒ Object
Returns the value of attribute total_dues.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def total_dues @total_dues end |
#trial_end ⇒ Object
Returns the value of attribute trial_end.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def trial_end @trial_end end |
#trial_end_action ⇒ Object
Returns the value of attribute trial_end_action.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def trial_end_action @trial_end_action end |
#trial_start ⇒ Object
Returns the value of attribute trial_start.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def trial_start @trial_start end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def updated_at @updated_at end |
Class Method Details
.add_charge_at_term_end(id, params, env = nil, headers = {}) ⇒ Object
183 184 185 186 187 |
# File 'lib/chargebee/models/subscription.rb', line 183 def self.add_charge_at_term_end(id, params, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"add_charge_at_term_end"), params, env, headers,nil, false, jsonKeys) end |
.cancel(id, params = {}, env = nil, headers = {}) ⇒ Object
277 278 279 280 281 |
# File 'lib/chargebee/models/subscription.rb', line 277 def self.cancel(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env, headers,nil, false, jsonKeys) end |
.cancel_for_items(id, params = {}, env = nil, headers = {}) ⇒ Object
283 284 285 286 287 |
# File 'lib/chargebee/models/subscription.rb', line 283 def self.cancel_for_items(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"cancel_for_items"), params, env, headers,nil, false, jsonKeys) end |
.change_term_end(id, params, env = nil, headers = {}) ⇒ Object
170 171 172 173 174 |
# File 'lib/chargebee/models/subscription.rb', line 170 def self.change_term_end(id, params, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env, headers,nil, false, jsonKeys) end |
.charge_addon_at_term_end(id, params, env = nil, headers = {}) ⇒ Object
189 190 191 192 193 |
# File 'lib/chargebee/models/subscription.rb', line 189 def self.charge_addon_at_term_end(id, params, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"charge_addon_at_term_end"), params, env, headers,nil, false, jsonKeys) end |
.charge_future_renewals(id, params = {}, env = nil, headers = {}) ⇒ Object
195 196 197 198 199 |
# File 'lib/chargebee/models/subscription.rb', line 195 def self.charge_future_renewals(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"charge_future_renewals"), params, env, headers,nil, false, jsonKeys) end |
.contract_terms_for_subscription(id, params = {}, env = nil, headers = {}) ⇒ Object
112 113 114 115 116 |
# File 'lib/chargebee/models/subscription.rb', line 112 def self.contract_terms_for_subscription(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("subscriptions",id.to_s,"contract_terms"), params, env, headers,nil, false, jsonKeys) end |
.create(params, env = nil, headers = {}) ⇒ Object
OPERATIONS
74 75 76 77 78 79 80 81 82 |
# File 'lib/chargebee/models/subscription.rb', line 74 def self.create(params, env=nil, headers={}) jsonKeys = { :meta_data => 0, :exemption_details => 1, :additional_information => 1, :billing_address => 1, } Request.send('post', uri_path("subscriptions"), params, env, headers,nil, false, jsonKeys) end |
.create_for_customer(id, params, env = nil, headers = {}) ⇒ Object
84 85 86 87 88 89 90 |
# File 'lib/chargebee/models/subscription.rb', line 84 def self.create_for_customer(id, params, env=nil, headers={}) jsonKeys = { :meta_data => 0, :additional_information => 1, } Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env, headers,nil, false, jsonKeys) end |
.create_with_items(id, params, env = nil, headers = {}) ⇒ Object
92 93 94 95 96 97 98 |
# File 'lib/chargebee/models/subscription.rb', line 92 def self.create_with_items(id, params, env=nil, headers={}) jsonKeys = { :meta_data => 0, :additional_information => 1, } Request.send('post', uri_path("customers",id.to_s,"subscription_for_items"), params, env, headers,nil, false, jsonKeys) end |
.delete(id, env = nil, headers = {}) ⇒ Object
265 266 267 268 269 |
# File 'lib/chargebee/models/subscription.rb', line 265 def self.delete(id, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"delete"), {}, env, headers,nil, false, jsonKeys) end |
.edit_advance_invoice_schedule(id, params = {}, env = nil, headers = {}) ⇒ Object
201 202 203 204 205 |
# File 'lib/chargebee/models/subscription.rb', line 201 def self.edit_advance_invoice_schedule(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"edit_advance_invoice_schedule"), params, env, headers,nil, false, jsonKeys) end |
.import_contract_term(id, params = {}, env = nil, headers = {}) ⇒ Object
240 241 242 243 244 |
# File 'lib/chargebee/models/subscription.rb', line 240 def self.import_contract_term(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"import_contract_term"), params, env, headers,nil, false, jsonKeys) end |
.import_for_customer(id, params, env = nil, headers = {}) ⇒ Object
233 234 235 236 237 238 |
# File 'lib/chargebee/models/subscription.rb', line 233 def self.import_for_customer(id, params, env=nil, headers={}) jsonKeys = { :meta_data => 0, } Request.send('post', uri_path("customers",id.to_s,"import_subscription"), params, env, headers,nil, false, jsonKeys) end |
.import_for_items(id, params, env = nil, headers = {}) ⇒ Object
252 253 254 255 256 257 |
# File 'lib/chargebee/models/subscription.rb', line 252 def self.import_for_items(id, params, env=nil, headers={}) jsonKeys = { :meta_data => 0, } Request.send('post', uri_path("customers",id.to_s,"import_for_items"), params, env, headers,nil, false, jsonKeys) end |
.import_subscription(params, env = nil, headers = {}) ⇒ Object
225 226 227 228 229 230 231 |
# File 'lib/chargebee/models/subscription.rb', line 225 def self.import_subscription(params, env=nil, headers={}) jsonKeys = { :meta_data => 0, :additional_information => 1, } Request.send('post', uri_path("subscriptions","import_subscription"), params, env, headers,nil, false, jsonKeys) end |
.import_unbilled_charges(id, params, env = nil, headers = {}) ⇒ Object
246 247 248 249 250 |
# File 'lib/chargebee/models/subscription.rb', line 246 def self.import_unbilled_charges(id, params, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"import_unbilled_charges"), params, env, headers,nil, false, jsonKeys) end |
.list(params = {}, env = nil, headers = {}) ⇒ Object
100 101 102 103 104 |
# File 'lib/chargebee/models/subscription.rb', line 100 def self.list(params={}, env=nil, headers={}) jsonKeys = { } Request.send_list_request('get', uri_path("subscriptions"), params, env, headers,nil, false, jsonKeys) end |
.list_discounts(id, params = {}, env = nil, headers = {}) ⇒ Object
118 119 120 121 122 |
# File 'lib/chargebee/models/subscription.rb', line 118 def self.list_discounts(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("subscriptions",id.to_s,"discounts"), params, env, headers,nil, false, jsonKeys) end |
.move(id, params, env = nil, headers = {}) ⇒ Object
308 309 310 311 312 |
# File 'lib/chargebee/models/subscription.rb', line 308 def self.move(id, params, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"move"), params, env, headers,nil, false, jsonKeys) end |
.override_billing_profile(id, params = {}, env = nil, headers = {}) ⇒ Object
259 260 261 262 263 |
# File 'lib/chargebee/models/subscription.rb', line 259 def self.override_billing_profile(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"override_billing_profile"), params, env, headers,nil, false, jsonKeys) end |
.pause(id, params = {}, env = nil, headers = {}) ⇒ Object
271 272 273 274 275 |
# File 'lib/chargebee/models/subscription.rb', line 271 def self.pause(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"pause"), params, env, headers,nil, false, jsonKeys) end |
.reactivate(id, params = {}, env = nil, headers = {}) ⇒ Object
176 177 178 179 180 181 |
# File 'lib/chargebee/models/subscription.rb', line 176 def self.reactivate(id, params={}, env=nil, headers={}) jsonKeys = { :additional_information => 1, } Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env, headers,nil, false, jsonKeys) end |
.regenerate_invoice(id, params = {}, env = nil, headers = {}) ⇒ Object
219 220 221 222 223 |
# File 'lib/chargebee/models/subscription.rb', line 219 def self.regenerate_invoice(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"regenerate_invoice"), params, env, headers,nil, false, jsonKeys) end |
.remove_advance_invoice_schedule(id, params = {}, env = nil, headers = {}) ⇒ Object
213 214 215 216 217 |
# File 'lib/chargebee/models/subscription.rb', line 213 def self.remove_advance_invoice_schedule(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_advance_invoice_schedule"), params, env, headers,nil, false, jsonKeys) end |
.remove_coupons(id, params = {}, env = nil, headers = {}) ⇒ Object
148 149 150 151 152 |
# File 'lib/chargebee/models/subscription.rb', line 148 def self.remove_coupons(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_coupons"), params, env, headers,nil, false, jsonKeys) end |
.remove_scheduled_cancellation(id, params = {}, env = nil, headers = {}) ⇒ Object
142 143 144 145 146 |
# File 'lib/chargebee/models/subscription.rb', line 142 def self.remove_scheduled_cancellation(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_cancellation"), params, env, headers,nil, false, jsonKeys) end |
.remove_scheduled_changes(id, env = nil, headers = {}) ⇒ Object
136 137 138 139 140 |
# File 'lib/chargebee/models/subscription.rb', line 136 def self.remove_scheduled_changes(id, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_changes"), {}, env, headers,nil, false, jsonKeys) end |
.remove_scheduled_pause(id, env = nil, headers = {}) ⇒ Object
296 297 298 299 300 |
# File 'lib/chargebee/models/subscription.rb', line 296 def self.remove_scheduled_pause(id, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_pause"), {}, env, headers,nil, false, jsonKeys) end |
.remove_scheduled_resumption(id, env = nil, headers = {}) ⇒ Object
302 303 304 305 306 |
# File 'lib/chargebee/models/subscription.rb', line 302 def self.remove_scheduled_resumption(id, env=nil, headers={}) jsonKeys = { } Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_resumption"), {}, env, headers,nil, false, jsonKeys) end |
.resume(id, params = {}, env = nil, headers = {}) ⇒ Object
289 290 291 292 293 294 |
# File 'lib/chargebee/models/subscription.rb', line 289 def self.resume(id, params={}, env=nil, headers={}) jsonKeys = { :additional_information => 1, } Request.send('post', uri_path("subscriptions",id.to_s,"resume"), params, env, headers,nil, false, jsonKeys) end |
.retrieve(id, env = nil, headers = {}) ⇒ Object
124 125 126 127 128 |
# File 'lib/chargebee/models/subscription.rb', line 124 def self.retrieve(id, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers,nil, false, jsonKeys) end |
.retrieve_advance_invoice_schedule(id, env = nil, headers = {}) ⇒ Object
207 208 209 210 211 |
# File 'lib/chargebee/models/subscription.rb', line 207 def self.retrieve_advance_invoice_schedule(id, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_advance_invoice_schedule"), {}, env, headers,nil, false, jsonKeys) end |
.retrieve_with_scheduled_changes(id, env = nil, headers = {}) ⇒ Object
130 131 132 133 134 |
# File 'lib/chargebee/models/subscription.rb', line 130 def self.retrieve_with_scheduled_changes(id, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_with_scheduled_changes"), {}, env, headers,nil, false, jsonKeys) end |
.subscriptions_for_customer(id, params = {}, env = nil, headers = {}) ⇒ Object
106 107 108 109 110 |
# File 'lib/chargebee/models/subscription.rb', line 106 def self.subscriptions_for_customer(id, params={}, env=nil, headers={}) jsonKeys = { } Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers,nil, false, jsonKeys) end |
.update(id, params = {}, env = nil, headers = {}) ⇒ Object
154 155 156 157 158 159 160 |
# File 'lib/chargebee/models/subscription.rb', line 154 def self.update(id, params={}, env=nil, headers={}) jsonKeys = { :meta_data => 0, :additional_information => 1, } Request.send('post', uri_path("subscriptions",id.to_s), params, env, headers,nil, false, jsonKeys) end |
.update_for_items(id, params, env = nil, headers = {}) ⇒ Object
162 163 164 165 166 167 168 |
# File 'lib/chargebee/models/subscription.rb', line 162 def self.update_for_items(id, params, env=nil, headers={}) jsonKeys = { :meta_data => 0, :additional_information => 1, } Request.send('post', uri_path("subscriptions",id.to_s,"update_for_items"), params, env, headers,nil, false, jsonKeys) end |