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, 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, 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, proration_behavior: nil, start_date: nil, transfer_data: nil, trial: nil, trial_end: nil) ⇒ Phase

Returns a new instance of Phase.



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1323

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,
  proration_behavior: nil,
  start_date: 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
  @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
  @proration_behavior = proration_behavior
  @start_date = start_date
  @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.



1277
1278
1279
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1277

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



1279
1280
1281
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1279

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this phase.



1281
1282
1283
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1281

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



1283
1284
1285
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1283

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.



1285
1286
1287
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1285

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.



1287
1288
1289
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1287

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



1289
1290
1291
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1289

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.



1291
1292
1293
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1291

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.



1293
1294
1295
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1293

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.



1295
1296
1297
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1295

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.



1297
1298
1299
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1297

def discounts
  @discounts
end

#duration ⇒ Object

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



1299
1300
1301
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1299

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.



1301
1302
1303
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1301

def end_date
  @end_date
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1303
1304
1305
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1303

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.



1305
1306
1307
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1305

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.



1307
1308
1309
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1307

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



1309
1310
1311
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1309

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

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



1311
1312
1313
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1311

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



1313
1314
1315
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1313

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.



1315
1316
1317
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1315

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.



1317
1318
1319
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1317

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.



1319
1320
1321
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1319

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`



1321
1322
1323
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1321

def trial_end
  @trial_end
end