Class: ChargeBee::Subscription
- Defined in:
- lib/chargebee/models/subscription.rb
Defined Under Namespace
Classes: Addon, Coupon, ShippingAddress
Instance Attribute Summary collapse
-
#activated_at ⇒ Object
Returns the value of attribute activated_at.
-
#addons ⇒ Object
Returns the value of attribute addons.
-
#cancel_reason ⇒ Object
Returns the value of attribute cancel_reason.
-
#cancelled_at ⇒ Object
Returns the value of attribute cancelled_at.
-
#coupon ⇒ Object
Returns the value of attribute coupon.
-
#coupons ⇒ Object
Returns the value of attribute coupons.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#current_term_end ⇒ Object
Returns the value of attribute current_term_end.
-
#current_term_start ⇒ Object
Returns the value of attribute current_term_start.
-
#due_invoices_count ⇒ Object
Returns the value of attribute due_invoices_count.
-
#due_since ⇒ Object
Returns the value of attribute due_since.
-
#id ⇒ Object
Returns the value of attribute id.
-
#plan_id ⇒ Object
Returns the value of attribute plan_id.
-
#plan_quantity ⇒ Object
Returns the value of attribute plan_quantity.
-
#remaining_billing_cycles ⇒ Object
Returns the value of attribute remaining_billing_cycles.
-
#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.
-
#total_dues ⇒ Object
Returns the value of attribute total_dues.
-
#trial_end ⇒ Object
Returns the value of attribute trial_end.
-
#trial_start ⇒ Object
Returns the value of attribute trial_start.
Class Method Summary collapse
- .add_credit(id, params, env = nil) ⇒ Object
- .cancel(id, params = {}, env = nil) ⇒ Object
- .change_term_end(id, params, env = nil) ⇒ Object
-
.create(params, env = nil) ⇒ Object
OPERATIONS ———–.
- .create_for_customer(id, params, env = nil) ⇒ Object
- .list(params = {}, env = nil) ⇒ Object
- .reactivate(id, params = {}, env = nil) ⇒ Object
- .retrieve(id, env = nil) ⇒ Object
- .subscriptions_for_customer(id, params = {}, env = nil) ⇒ Object
- .update(id, params = {}, env = nil) ⇒ Object
Methods inherited from Model
construct, #initialize, #inspect, #load, #method_missing, #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.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def activated_at @activated_at end |
#addons ⇒ Object
Returns the value of attribute addons.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def addons @addons end |
#cancel_reason ⇒ Object
Returns the value of attribute cancel_reason.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def cancel_reason @cancel_reason end |
#cancelled_at ⇒ Object
Returns the value of attribute cancelled_at.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def cancelled_at @cancelled_at end |
#coupon ⇒ Object
Returns the value of attribute coupon.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def coupon @coupon end |
#coupons ⇒ Object
Returns the value of attribute coupons.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def coupons @coupons end |
#created_at ⇒ Object
Returns the value of attribute created_at.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def created_at @created_at end |
#current_term_end ⇒ Object
Returns the value of attribute current_term_end.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def current_term_end @current_term_end end |
#current_term_start ⇒ Object
Returns the value of attribute current_term_start.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def current_term_start @current_term_start end |
#due_invoices_count ⇒ Object
Returns the value of attribute due_invoices_count.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def due_invoices_count @due_invoices_count end |
#due_since ⇒ Object
Returns the value of attribute due_since.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def due_since @due_since end |
#id ⇒ Object
Returns the value of attribute id.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def id @id end |
#plan_id ⇒ Object
Returns the value of attribute plan_id.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def plan_id @plan_id end |
#plan_quantity ⇒ Object
Returns the value of attribute plan_quantity.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def plan_quantity @plan_quantity end |
#remaining_billing_cycles ⇒ Object
Returns the value of attribute remaining_billing_cycles.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def remaining_billing_cycles @remaining_billing_cycles end |
#shipping_address ⇒ Object
Returns the value of attribute shipping_address.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def shipping_address @shipping_address end |
#start_date ⇒ Object
Returns the value of attribute start_date.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def start_date @start_date end |
#started_at ⇒ Object
Returns the value of attribute started_at.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def started_at @started_at end |
#status ⇒ Object
Returns the value of attribute status.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def status @status end |
#total_dues ⇒ Object
Returns the value of attribute total_dues.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def total_dues @total_dues end |
#trial_end ⇒ Object
Returns the value of attribute trial_end.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def trial_end @trial_end end |
#trial_start ⇒ Object
Returns the value of attribute trial_start.
16 17 18 |
# File 'lib/chargebee/models/subscription.rb', line 16 def trial_start @trial_start end |
Class Method Details
.add_credit(id, params, env = nil) ⇒ Object
60 61 62 |
# File 'lib/chargebee/models/subscription.rb', line 60 def self.add_credit(id, params, env=nil) Request.send('post', uri_path("subscriptions",id.to_s,"add_credit"), params, env) end |
.cancel(id, params = {}, env = nil) ⇒ Object
52 53 54 |
# File 'lib/chargebee/models/subscription.rb', line 52 def self.cancel(id, params={}, env=nil) Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env) end |
.change_term_end(id, params, env = nil) ⇒ Object
48 49 50 |
# File 'lib/chargebee/models/subscription.rb', line 48 def self.change_term_end(id, params, env=nil) Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env) end |
.create(params, env = nil) ⇒ Object
OPERATIONS
24 25 26 |
# File 'lib/chargebee/models/subscription.rb', line 24 def self.create(params, env=nil) Request.send('post', uri_path("subscriptions"), params, env) end |
.create_for_customer(id, params, env = nil) ⇒ Object
28 29 30 |
# File 'lib/chargebee/models/subscription.rb', line 28 def self.create_for_customer(id, params, env=nil) Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env) end |
.list(params = {}, env = nil) ⇒ Object
32 33 34 |
# File 'lib/chargebee/models/subscription.rb', line 32 def self.list(params={}, env=nil) Request.send('get', uri_path("subscriptions"), params, env) end |
.reactivate(id, params = {}, env = nil) ⇒ Object
56 57 58 |
# File 'lib/chargebee/models/subscription.rb', line 56 def self.reactivate(id, params={}, env=nil) Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env) end |
.retrieve(id, env = nil) ⇒ Object
40 41 42 |
# File 'lib/chargebee/models/subscription.rb', line 40 def self.retrieve(id, env=nil) Request.send('get', uri_path("subscriptions",id.to_s), {}, env) end |