Class: Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/invoice_service.rb

Defined Under Namespace

Classes: Item, Prebilling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_cycle_anchor: nil, cancel_at: nil, cancel_at_period_end: nil, cancel_now: nil, default_tax_rates: nil, items: nil, prebilling: nil, proration_behavior: nil, proration_date: nil, resume_at: nil, start_date: nil, trial_end: nil) ⇒ SubscriptionDetails

Returns a new instance of SubscriptionDetails.



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
 
# File 'lib/stripe/services/invoice_service.rb', line 5444

def initialize(
  billing_cycle_anchor: nil,
  cancel_at: nil,
  cancel_at_period_end: nil,
  cancel_now: nil,
  default_tax_rates: nil,
  items: nil,
  prebilling: nil,
  proration_behavior: nil,
  proration_date: nil,
  resume_at: nil,
  start_date: nil,
  trial_end: nil
)
  @billing_cycle_anchor = billing_cycle_anchor
  @cancel_at = cancel_at
  @cancel_at_period_end = cancel_at_period_end
  @cancel_now = cancel_now
  @default_tax_rates = default_tax_rates
  @items = items
  @prebilling = prebilling
  @proration_behavior = proration_behavior
  @proration_date = proration_date
  @resume_at = resume_at
  @start_date = start_date
  @trial_end = trial_end
end

Instance Attribute Details

#billing_cycle_anchor ⇒ Object

For new subscriptions, a future timestamp to anchor the subscription’s [billing cycle](stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with ‘month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.



5420
5421
5422
 
# File 'lib/stripe/services/invoice_service.rb', line 5420

def billing_cycle_anchor
  @billing_cycle_anchor
end

#cancel_at ⇒ Object

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using ‘proration_behavior`. If set during a future period, this will always cause a proration for that period.



5422
5423
5424
 
# File 'lib/stripe/services/invoice_service.rb', line 5422

def cancel_at
  @cancel_at
end

#cancel_at_period_end ⇒ Object

Indicate whether this subscription should cancel at the end of the current period (‘current_period_end`). Defaults to `false`.



5424
5425
5426
 
# File 'lib/stripe/services/invoice_service.rb', line 5424

def cancel_at_period_end
  @cancel_at_period_end
end

#cancel_now ⇒ Object

This simulates the subscription being canceled or expired immediately.



5426
5427
5428
 
# File 'lib/stripe/services/invoice_service.rb', line 5426

def cancel_now
  @cancel_now
end

#default_tax_rates ⇒ Object

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have ‘tax_rates` set.



5428
5429
5430
 
# File 'lib/stripe/services/invoice_service.rb', line 5428

def default_tax_rates
  @default_tax_rates
end

#items ⇒ Object

A list of up to 20 subscription items, each with an attached price.



5430
5431
5432
 
# File 'lib/stripe/services/invoice_service.rb', line 5430

def items
  @items
end

#prebilling ⇒ Object

The pre-billing to apply to the subscription as a preview.



5432
5433
5434
 
# File 'lib/stripe/services/invoice_service.rb', line 5432

def prebilling
  @prebilling
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting ‘billing_cycle_anchor=now`, or starting a trial), or if an item’s ‘quantity` changes. The default value is `create_prorations`.



5434
5435
5436
 
# File 'lib/stripe/services/invoice_service.rb', line 5434

def proration_behavior
  @proration_behavior
end

#proration_date ⇒ Object

If previewing an update to a subscription, and doing proration, ‘subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to ’none’.



5436
5437
5438
 
# File 'lib/stripe/services/invoice_service.rb', line 5436

def proration_date
  @proration_date
end

#resume_at ⇒ Object

For paused subscriptions, setting ‘subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.



5438
5439
5440
 
# File 'lib/stripe/services/invoice_service.rb', line 5438

def resume_at
  @resume_at
end

#start_date ⇒ Object

Date a subscription is intended to start (can be future or past).



5440
5441
5442
 
# File 'lib/stripe/services/invoice_service.rb', line 5440

def start_date
  @start_date
end

#trial_end ⇒ Object

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of ‘subscription_details.items` or `subscription` is required.



5442
5443
5444
 
# File 'lib/stripe/services/invoice_service.rb', line 5442

def trial_end
  @trial_end
end