Class: Stripe::SubscriptionService::ResumeParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/subscription_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_cycle_anchor: nil, expand: nil, proration_behavior: nil, proration_date: nil) ⇒ ResumeParams

Returns a new instance of ResumeParams.



1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/stripe/services/subscription_service.rb', line 1903

def initialize(
  billing_cycle_anchor: nil,
  expand: nil,
  proration_behavior: nil,
  proration_date: nil
)
  @billing_cycle_anchor = billing_cycle_anchor
  @expand = expand
  @proration_behavior = proration_behavior
  @proration_date = proration_date
end

Instance Attribute Details

#billing_cycle_anchor ⇒ Object

The billing cycle anchor that applies when the subscription is resumed. Either ‘now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](stripe.com/docs/billing/subscriptions/billing-cycle).



1895
1896
1897
 
# File 'lib/stripe/services/subscription_service.rb', line 1895

def billing_cycle_anchor
  @billing_cycle_anchor
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1897
1898
1899
 
# File 'lib/stripe/services/subscription_service.rb', line 1897

def expand
  @expand
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](stripe.com/docs/billing/subscriptions/prorations) resulting from the ‘billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.



1899
1900
1901
 
# File 'lib/stripe/services/subscription_service.rb', line 1899

def proration_behavior
  @proration_behavior
end

#proration_date ⇒ Object

If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](stripe.com/docs/api/invoices/create_preview) endpoint.



1901
1902
1903
 
# File 'lib/stripe/services/subscription_service.rb', line 1901

def proration_date
  @proration_date
end