Class: Stripe::Checkout::SessionCreateParams::SubscriptionData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_create_params.rb

Defined Under Namespace

Classes: BillingMode, InvoiceSettings, PendingInvoiceItemInterval, TransferData, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(application_fee_percent: nil, billing_cycle_anchor: nil, billing_mode: nil, default_tax_rates: nil, description: nil, invoice_settings: nil, metadata: nil, on_behalf_of: nil, pending_invoice_item_interval: nil, proration_behavior: nil, transfer_data: nil, trial_end: nil, trial_period_days: nil, trial_settings: nil) ⇒ SubscriptionData

Returns a new instance of SubscriptionData.



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2327

def initialize(
  application_fee_percent: nil,
  billing_cycle_anchor: nil,
  billing_mode: nil,
  default_tax_rates: nil,
  description: nil,
  invoice_settings: nil,
  metadata: nil,
  on_behalf_of: nil,
  pending_invoice_item_interval: nil,
  proration_behavior: nil,
  transfer_data: nil,
  trial_end: nil,
  trial_period_days: nil,
  trial_settings: nil
)
  @application_fee_percent = application_fee_percent
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_mode = billing_mode
  @default_tax_rates = default_tax_rates
  @description = description
  @invoice_settings = invoice_settings
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @pending_invoice_item_interval = pending_invoice_item_interval
  @proration_behavior = proration_behavior
  @transfer_data = transfer_data
  @trial_end = trial_end
  @trial_period_days = trial_period_days
  @trial_settings = trial_settings
end

Instance Attribute Details

#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. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.



2295
2296
2297
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2295

def application_fee_percent
  @application_fee_percent
end

#billing_cycle_anchor ⇒ Object

A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if ui_mode is custom.



2297
2298
2299
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2297

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_mode ⇒ Object

Controls how prorations and invoices for subscriptions are calculated and orchestrated.



2299
2300
2301
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2299

def billing_mode
  @billing_mode
end

#default_tax_rates ⇒ Object

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.



2303
2304
2305
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2303

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the customer portal.



2307
2308
2309
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2307

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



2309
2310
2311
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2309

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



2311
2312
2313
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2311

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

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



2313
2314
2315
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2313

def on_behalf_of
  @on_behalf_of
end

#pending_invoice_item_interval ⇒ Object

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.



2315
2316
2317
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2315

def pending_invoice_item_interval
  @pending_invoice_item_interval
end

#proration_behavior ⇒ Object

Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.



2317
2318
2319
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2317

def proration_behavior
  @proration_behavior
end

#transfer_data ⇒ Object

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.



2319
2320
2321
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2319

def transfer_data
  @transfer_data
end

#trial_end ⇒ Object

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.



2321
2322
2323
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2321

def trial_end
  @trial_end
end

#trial_period_days ⇒ Object

Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.



2323
2324
2325
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2323

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



2325
2326
2327
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2325

def trial_settings
  @trial_settings
end