Class: Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.rb

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, BillingThresholds, Discount, Duration, InvoiceSettings, Item, PauseCollection, TransferData, TrialSettings

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, billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, default_tax_rates: nil, description: nil, discounts: nil, duration: nil, end_date: nil, invoice_settings: nil, items: nil, iterations: nil, metadata: nil, on_behalf_of: nil, pause_collection: nil, proration_behavior: nil, start_date: nil, transfer_data: nil, trial: nil, trial_continuation: nil, trial_end: nil, trial_settings: nil) ⇒ Phase

Returns a new instance of Phase.



3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
 
# File 'lib/stripe/resources/invoice.rb', line 3926

def initialize(
  add_invoice_items: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  billing_cycle_anchor: nil,
  billing_thresholds: nil,
  collection_method: nil,
  currency: nil,
  default_payment_method: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  duration: nil,
  end_date: nil,
  invoice_settings: nil,
  items: nil,
  iterations: nil,
  metadata: nil,
  on_behalf_of: nil,
  pause_collection: nil,
  proration_behavior: nil,
  start_date: nil,
  transfer_data: nil,
  trial: nil,
  trial_continuation: nil,
  trial_end: nil,
  trial_settings: nil
)
  @add_invoice_items = add_invoice_items
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_thresholds = billing_thresholds
  @collection_method = collection_method
  @currency = currency
  @default_payment_method = default_payment_method
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @duration = duration
  @end_date = end_date
  @invoice_settings = invoice_settings
  @items = items
  @iterations = iterations
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @pause_collection = pause_collection
  @proration_behavior = proration_behavior
  @start_date = start_date
  @transfer_data = transfer_data
  @trial = trial
  @trial_continuation = trial_continuation
  @trial_end = trial_end
  @trial_settings = trial_settings
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.



3874
3875
3876
 
# File 'lib/stripe/resources/invoice.rb', line 3874

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



3876
3877
3878
 
# File 'lib/stripe/resources/invoice.rb', line 3876

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this phase.



3878
3879
3880
 
# File 'lib/stripe/resources/invoice.rb', line 3878

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



3880
3881
3882
 
# File 'lib/stripe/resources/invoice.rb', line 3880

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_thresholds ⇒ Object

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.



3882
3883
3884
 
# File 'lib/stripe/resources/invoice.rb', line 3882

def billing_thresholds
  @billing_thresholds
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.



3884
3885
3886
 
# File 'lib/stripe/resources/invoice.rb', line 3884

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



3886
3887
3888
 
# File 'lib/stripe/resources/invoice.rb', line 3886

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.



3888
3889
3890
 
# File 'lib/stripe/resources/invoice.rb', line 3888

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.



3890
3891
3892
 
# File 'lib/stripe/resources/invoice.rb', line 3890

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.



3892
3893
3894
 
# File 'lib/stripe/resources/invoice.rb', line 3892

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.



3894
3895
3896
 
# File 'lib/stripe/resources/invoice.rb', line 3894

def discounts
  @discounts
end

#duration ⇒ Object

The number of intervals the phase should last. If set, ‘end_date` must not be set.



3896
3897
3898
 
# File 'lib/stripe/resources/invoice.rb', line 3896

def duration
  @duration
end

#end_date ⇒ Object

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



3898
3899
3900
 
# File 'lib/stripe/resources/invoice.rb', line 3898

def end_date
  @end_date
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



3900
3901
3902
 
# File 'lib/stripe/resources/invoice.rb', line 3900

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.



3902
3903
3904
 
# File 'lib/stripe/resources/invoice.rb', line 3902

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. This parameter is deprecated and will be removed in a future version. Use `duration` instead.



3904
3905
3906
 
# File 'lib/stripe/resources/invoice.rb', line 3904

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



3906
3907
3908
 
# File 'lib/stripe/resources/invoice.rb', line 3906

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

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



3908
3909
3910
 
# File 'lib/stripe/resources/invoice.rb', line 3908

def on_behalf_of
  @on_behalf_of
end

#pause_collection ⇒ Object

If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to ‘paused`. Learn more about [pausing collection](stripe.com/docs/billing/subscriptions/pause-payment).



3910
3911
3912
 
# File 'lib/stripe/resources/invoice.rb', line 3910

def pause_collection
  @pause_collection
end

#proration_behavior ⇒ Object

Controls whether the subscription schedule should create [prorations](stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. 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 (item price, quantity, etc.) of the current phase.



3912
3913
3914
 
# File 'lib/stripe/resources/invoice.rb', line 3912

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object

The date at which this phase of the subscription schedule starts or ‘now`. Must be set on the first phase.



3914
3915
3916
 
# File 'lib/stripe/resources/invoice.rb', line 3914

def start_date
  @start_date
end

#transfer_data ⇒ Object

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



3916
3917
3918
 
# File 'lib/stripe/resources/invoice.rb', line 3916

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.



3918
3919
3920
 
# File 'lib/stripe/resources/invoice.rb', line 3918

def trial
  @trial
end

#trial_continuation ⇒ Object

Specify trial behavior when crossing phase boundaries



3920
3921
3922
 
# File 'lib/stripe/resources/invoice.rb', line 3920

def trial_continuation
  @trial_continuation
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`



3922
3923
3924
 
# File 'lib/stripe/resources/invoice.rb', line 3922

def trial_end
  @trial_end
end

#trial_settings ⇒ Object

Settings related to subscription trials.



3924
3925
3926
 
# File 'lib/stripe/resources/invoice.rb', line 3924

def trial_settings
  @trial_settings
end