class ChargeBee::Subscription

Attributes

activated_at[RW]
addons[RW]
affiliate_token[RW]
auto_close_invoices[RW]
auto_collection[RW]
base_currency_code[RW]
billing_period[RW]
billing_period_unit[RW]
cancel_reason[RW]
cancel_reason_code[RW]
cancel_schedule_created_at[RW]
cancelled_at[RW]
changes_scheduled_at[RW]
channel[RW]
charged_event_based_addons[RW]
charged_items[RW]
contract_term[RW]
contract_term_billing_cycle_on_renewal[RW]
coupon[RW]
coupons[RW]
create_pending_invoices[RW]
created_at[RW]
created_from_ip[RW]
currency_code[RW]
current_term_end[RW]
current_term_start[RW]
customer_id[RW]
deleted[RW]
due_invoices_count[RW]
due_since[RW]
event_based_addons[RW]
exchange_rate[RW]
free_period[RW]
free_period_unit[RW]
gift_id[RW]
has_scheduled_advance_invoices[RW]
has_scheduled_changes[RW]
id[RW]
invoice_notes[RW]
item_tiers[RW]
meta_data[RW]
metadata[RW]
mrr[RW]
next_billing_at[RW]
offline_payment_method[RW]
override_relationship[RW]
pause_date[RW]
payment_source_id[RW]
plan_amount[RW]
plan_amount_in_decimal[RW]
plan_free_quantity[RW]
plan_free_quantity_in_decimal[RW]
plan_id[RW]
plan_quantity[RW]
plan_quantity_in_decimal[RW]
plan_unit_price[RW]
plan_unit_price_in_decimal[RW]
po_number[RW]
referral_info[RW]
remaining_billing_cycles[RW]
resource_version[RW]
resume_date[RW]
setup_fee[RW]
shipping_address[RW]
start_date[RW]
started_at[RW]
status[RW]
subscription_items[RW]
total_dues[RW]
trial_end[RW]
trial_end_action[RW]
trial_start[RW]
updated_at[RW]

Public Class Methods

add_charge_at_term_end(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 121
def self.add_charge_at_term_end(id, params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"add_charge_at_term_end"), params, env, headers)
end
cancel(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 177
def self.cancel(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env, headers)
end
cancel_for_items(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 181
def self.cancel_for_items(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"cancel_for_items"), params, env, headers)
end
change_term_end(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 113
def self.change_term_end(id, params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env, headers)
end
charge_addon_at_term_end(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 125
def self.charge_addon_at_term_end(id, params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"charge_addon_at_term_end"), params, env, headers)
end
charge_future_renewals(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 129
def self.charge_future_renewals(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"charge_future_renewals"), params, env, headers)
end
contract_terms_for_subscription(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 81
def self.contract_terms_for_subscription(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("subscriptions",id.to_s,"contract_terms"), params, env, headers)
end
create(params, env=nil, headers={}) click to toggle source

OPERATIONS

# File lib/chargebee/models/subscription.rb, line 61
def self.create(params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions"), params, env, headers)
end
create_for_customer(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 65
def self.create_for_customer(id, params, env=nil, headers={})
  Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
end
create_with_items(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 69
def self.create_with_items(id, params, env=nil, headers={})
  Request.send('post', uri_path("customers",id.to_s,"subscription_for_items"), params, env, headers)
end
delete(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 169
def self.delete(id, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"delete"), {}, env, headers)
end
edit_advance_invoice_schedule(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 133
def self.edit_advance_invoice_schedule(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"edit_advance_invoice_schedule"), params, env, headers)
end
import_contract_term(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 157
def self.import_contract_term(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"import_contract_term"), params, env, headers)
end
import_for_customer(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 153
def self.import_for_customer(id, params, env=nil, headers={})
  Request.send('post', uri_path("customers",id.to_s,"import_subscription"), params, env, headers)
end
import_for_items(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 161
def self.import_for_items(id, params, env=nil, headers={})
  Request.send('post', uri_path("customers",id.to_s,"import_for_items"), params, env, headers)
end
import_subscription(params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 149
def self.import_subscription(params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions","import_subscription"), params, env, headers)
end
list(params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 73
def self.list(params={}, env=nil, headers={})
  Request.send_list_request('get', uri_path("subscriptions"), params, env, headers)
end
override_billing_profile(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 165
def self.override_billing_profile(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"override_billing_profile"), params, env, headers)
end
pause(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 173
def self.pause(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"pause"), params, env, headers)
end
reactivate(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 117
def self.reactivate(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env, headers)
end
regenerate_invoice(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 145
def self.regenerate_invoice(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"regenerate_invoice"), params, env, headers)
end
remove_advance_invoice_schedule(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 141
def self.remove_advance_invoice_schedule(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_advance_invoice_schedule"), params, env, headers)
end
remove_coupons(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 101
def self.remove_coupons(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_coupons"), params, env, headers)
end
remove_scheduled_cancellation(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 97
def self.remove_scheduled_cancellation(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_cancellation"), params, env, headers)
end
remove_scheduled_changes(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 93
def self.remove_scheduled_changes(id, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_changes"), {}, env, headers)
end
remove_scheduled_pause(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 189
def self.remove_scheduled_pause(id, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_pause"), {}, env, headers)
end
remove_scheduled_resumption(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 193
def self.remove_scheduled_resumption(id, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_resumption"), {}, env, headers)
end
resume(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 185
def self.resume(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"resume"), params, env, headers)
end
retrieve(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 85
def self.retrieve(id, env=nil, headers={})
  Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers)
end
retrieve_advance_invoice_schedule(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 137
def self.retrieve_advance_invoice_schedule(id, env=nil, headers={})
  Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_advance_invoice_schedule"), {}, env, headers)
end
retrieve_with_scheduled_changes(id, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 89
def self.retrieve_with_scheduled_changes(id, env=nil, headers={})
  Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_with_scheduled_changes"), {}, env, headers)
end
subscriptions_for_customer(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 77
def self.subscriptions_for_customer(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
end
update(id, params={}, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 105
def self.update(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s), params, env, headers)
end
update_for_items(id, params, env=nil, headers={}) click to toggle source
# File lib/chargebee/models/subscription.rb, line 109
def self.update_for_items(id, params, env=nil, headers={})
  Request.send('post', uri_path("subscriptions",id.to_s,"update_for_items"), params, env, headers)
end