Class: Stripe::SubscriptionSchedule::UpdateParams::Phase

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/subscription_schedule.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.



2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2121

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.



2069
2070
2071
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2069

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



2071
2072
2073
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2071

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this phase.



2073
2074
2075
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2073

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



2075
2076
2077
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2075

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.



2077
2078
2079
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2077

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.



2079
2080
2081
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2079

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



2081
2082
2083
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2081

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.



2083
2084
2085
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2083

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.



2085
2086
2087
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2085

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.



2087
2088
2089
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2087

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.



2089
2090
2091
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2089

def discounts
  @discounts
end

#duration ⇒ Object

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



2091
2092
2093
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2091

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.



2093
2094
2095
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2093

def end_date
  @end_date
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



2095
2096
2097
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2095

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.



2097
2098
2099
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2097

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.



2099
2100
2101
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2099

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



2101
2102
2103
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2101

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

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



2103
2104
2105
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2103

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



2105
2106
2107
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2105

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.



2107
2108
2109
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2107

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.



2109
2110
2111
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2109

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.



2111
2112
2113
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2111

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.



2113
2114
2115
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2113

def trial
  @trial
end

#trial_continuation ⇒ Object

Specify trial behavior when crossing phase boundaries



2115
2116
2117
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2115

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`



2117
2118
2119
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2117

def trial_end
  @trial_end
end

#trial_settings ⇒ Object

Settings related to subscription trials.



2119
2120
2121
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 2119

def trial_settings
  @trial_settings
end