Class: Stripe::SubscriptionResumeParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/subscription_resume_params.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) ⇒ SubscriptionResumeParams

Returns a new instance of SubscriptionResumeParams.



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/stripe/params/subscription_resume_params.rb', line 15

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).



7
8
9
 
# File 'lib/stripe/params/subscription_resume_params.rb', line 7

def billing_cycle_anchor
  @billing_cycle_anchor
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



9
10
11
 
# File 'lib/stripe/params/subscription_resume_params.rb', line 9

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`.



11
12
13
 
# File 'lib/stripe/params/subscription_resume_params.rb', line 11

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.



13
14
15
 
# File 'lib/stripe/params/subscription_resume_params.rb', line 13

def proration_date
  @proration_date
end