Class: Stripe::SubscriptionScheduleCreateParams::DefaultSettings

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

Defined Under Namespace

Classes: AutomaticTax, BillingThresholds, InvoiceSettings, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, invoice_settings: nil, on_behalf_of: nil, transfer_data: nil, phase_effective_at: nil) ⇒ DefaultSettings

Returns a new instance of DefaultSettings.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 174

def initialize(
  application_fee_percent: nil,
  automatic_tax: nil,
  billing_cycle_anchor: nil,
  billing_thresholds: nil,
  collection_method: nil,
  default_payment_method: nil,
  description: nil,
  invoice_settings: nil,
  on_behalf_of: nil,
  transfer_data: nil,
  phase_effective_at: nil
)
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_thresholds = billing_thresholds
  @collection_method = collection_method
  @default_payment_method = default_payment_method
  @description = description
  @invoice_settings = invoice_settings
  @on_behalf_of = on_behalf_of
  @transfer_data = transfer_data
  @phase_effective_at = phase_effective_at
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. 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).



152
153
154
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 152

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Default settings for automatic tax computation.



154
155
156
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 154

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



156
157
158
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 156

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.



158
159
160
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 158

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.



160
161
162
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 160

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



162
163
164
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 162

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



164
165
166
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 164

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



166
167
168
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 166

def invoice_settings
  @invoice_settings
end

#on_behalf_of ⇒ Object

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



168
169
170
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 168

def on_behalf_of
  @on_behalf_of
end

#phase_effective_at ⇒ Object

Configures how the subscription schedule handles billing for phase transitions. Possible values are ‘phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.



172
173
174
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 172

def phase_effective_at
  @phase_effective_at
end

#transfer_data ⇒ Object

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



170
171
172
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 170

def transfer_data
  @transfer_data
end