Class: Stripe::SubscriptionScheduleService::CreateParams::Phase

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

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, Discount, InvoiceSettings, Item, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, collection_method: nil, currency: nil, default_payment_method: nil, default_tax_rates: nil, description: nil, discounts: nil, end_date: nil, invoice_settings: nil, items: nil, iterations: nil, metadata: nil, on_behalf_of: nil, proration_behavior: nil, transfer_data: nil, trial: nil, trial_end: nil) ⇒ Phase

Returns a new instance of Phase.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 498

def initialize(
  add_invoice_items: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  billing_cycle_anchor: nil,
  collection_method: nil,
  currency: nil,
  default_payment_method: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  end_date: nil,
  invoice_settings: nil,
  items: nil,
  iterations: nil,
  metadata: nil,
  on_behalf_of: nil,
  proration_behavior: nil,
  transfer_data: nil,
  trial: nil,
  trial_end: nil
)
  @add_invoice_items = add_invoice_items
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @billing_cycle_anchor = billing_cycle_anchor
  @collection_method = collection_method
  @currency = currency
  @default_payment_method = default_payment_method
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @end_date = end_date
  @invoice_settings = invoice_settings
  @items = items
  @iterations = iterations
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @proration_behavior = proration_behavior
  @transfer_data = transfer_data
  @trial = trial
  @trial_end = trial_end
end

Instance Attribute Details

#add_invoice_items ⇒ Object

A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.



458
459
460
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 458

def add_invoice_items
  @add_invoice_items
end

#application_fee_percent ⇒ Object

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).



460
461
462
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 460

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this phase.



462
463
464
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 462

def automatic_tax
  @automatic_tax
end

#billing_cycle_anchor ⇒ Object

Can be set to ‘phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](stripe.com/docs/billing/subscriptions/billing-cycle).



464
465
466
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 464

def billing_cycle_anchor
  @billing_cycle_anchor
end

#collection_method ⇒ Object

Either ‘charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.



466
467
468
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 466

def collection_method
  @collection_method
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



468
469
470
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 468

def currency
  @currency
end

#default_payment_method ⇒ Object

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings.



470
471
472
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 470

def default_payment_method
  @default_payment_method
end

#default_tax_rates ⇒ Object

A list of [Tax Rate](stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription’s [‘default_tax_rates`](stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice’s [‘default_tax_rates`](stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.



472
473
474
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 472

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.



474
475
476
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 474

def description
  @description
end

#discounts ⇒ Object

The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription’s customer. Pass an empty string to avoid inheriting any discounts.



476
477
478
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 476

def discounts
  @discounts
end

#end_date ⇒ Object

The date at which this phase of the subscription schedule ends. If set, ‘iterations` must not be set.



478
479
480
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 478

def end_date
  @end_date
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



480
481
482
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 480

def invoice_settings
  @invoice_settings
end

#items ⇒ Object

List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.



482
483
484
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 482

def items
  @items
end

#iterations ⇒ Object

Integer representing the multiplier applied to the price interval. For example, ‘iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.



484
485
486
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 484

def iterations
  @iterations
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule’s phase will update the underlying subscription’s ‘metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription’s ‘metadata`. Individual keys in the subscription’s ‘metadata` can be unset by posting an empty value to them in the phase’s ‘metadata`. To unset all keys in the subscription’s ‘metadata`, update the subscription directly or unset every key individually from the phase’s ‘metadata`.



486
487
488
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 486

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge, for each of the associated subscription’s invoices.



488
489
490
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 488

def on_behalf_of
  @on_behalf_of
end

#proration_behavior ⇒ Object

Whether the subscription schedule will create [prorations](stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is ‘create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It’s different from the request-level [proration_behavior](stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.



490
491
492
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 490

def proration_behavior
  @proration_behavior
end

#transfer_data ⇒ Object

The data with which to automatically create a Transfer for each of the associated subscription’s invoices.



492
493
494
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 492

def transfer_data
  @transfer_data
end

#trial ⇒ Object

If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.



494
495
496
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 494

def trial
  @trial
end

#trial_end ⇒ Object

Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with ‘trial`



496
497
498
 
# File 'lib/stripe/services/subscription_schedule_service.rb', line 496

def trial_end
  @trial_end
end