Class: Stripe::QuoteUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/quote_update_params.rb

Defined Under Namespace

Classes: AutomaticTax, Discount, InvoiceSettings, Line, LineItem, SubscriptionData, SubscriptionDataOverride, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(allow_backdated_lines: nil, application_fee_amount: nil, application_fee_percent: nil, automatic_tax: nil, collection_method: nil, customer: nil, customer_account: nil, default_tax_rates: nil, description: nil, discounts: nil, expand: nil, expires_at: nil, footer: nil, header: nil, invoice_settings: nil, line_items: nil, lines: nil, metadata: nil, on_behalf_of: nil, subscription_data: nil, subscription_data_overrides: nil, transfer_data: nil) ⇒ QuoteUpdateParams

Returns a new instance of QuoteUpdateParams.



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/stripe/params/quote_update_params.rb', line 1232

def initialize(
  allow_backdated_lines: nil,
  application_fee_amount: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  collection_method: nil,
  customer: nil,
  customer_account: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  expand: nil,
  expires_at: nil,
  footer: nil,
  header: nil,
  invoice_settings: nil,
  line_items: nil,
  lines: nil,
  metadata: nil,
  on_behalf_of: nil,
  subscription_data: nil,
  subscription_data_overrides: nil,
  transfer_data: nil
)
  @allow_backdated_lines = allow_backdated_lines
  @application_fee_amount = application_fee_amount
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @collection_method = collection_method
  @customer = customer
  @customer_account = 
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @expand = expand
  @expires_at = expires_at
  @footer = footer
  @header = header
  @invoice_settings = invoice_settings
  @line_items = line_items
  @lines = lines
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @subscription_data = subscription_data
  @subscription_data_overrides = subscription_data_overrides
  @transfer_data = transfer_data
end

Instance Attribute Details

#allow_backdated_lines ⇒ Object

Set to true to allow quote lines to have ‘starts_at` in the past if collection is paused between `starts_at` and now.



1188
1189
1190
 
# File 'lib/stripe/params/quote_update_params.rb', line 1188

def allow_backdated_lines
  @allow_backdated_lines
end

#application_fee_amount ⇒ Object

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. There cannot be any line items with recurring prices when using this field.



1190
1191
1192
 
# File 'lib/stripe/params/quote_update_params.rb', line 1190

def application_fee_amount
  @application_fee_amount
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. There must be at least 1 line item with a recurring price to use this field.



1192
1193
1194
 
# File 'lib/stripe/params/quote_update_params.rb', line 1192

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.



1194
1195
1196
 
# File 'lib/stripe/params/quote_update_params.rb', line 1194

def automatic_tax
  @automatic_tax
end

#collection_method ⇒ Object

Either ‘charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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`.



1196
1197
1198
 
# File 'lib/stripe/params/quote_update_params.rb', line 1196

def collection_method
  @collection_method
end

#customer ⇒ Object

The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.



1198
1199
1200
 
# File 'lib/stripe/params/quote_update_params.rb', line 1198

def customer
  @customer
end

#customer_account ⇒ Object

The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.



1200
1201
1202
 
# File 'lib/stripe/params/quote_update_params.rb', line 1200

def 
  @customer_account
end

#default_tax_rates ⇒ Object

The tax rates that will apply to any line item that does not have ‘tax_rates` set.



1202
1203
1204
 
# File 'lib/stripe/params/quote_update_params.rb', line 1202

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF.



1204
1205
1206
 
# File 'lib/stripe/params/quote_update_params.rb', line 1204

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



1206
1207
1208
 
# File 'lib/stripe/params/quote_update_params.rb', line 1206

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1208
1209
1210
 
# File 'lib/stripe/params/quote_update_params.rb', line 1208

def expand
  @expand
end

#expires_at ⇒ Object

A future timestamp on which the quote will be canceled if in ‘open` or `draft` status. Measured in seconds since the Unix epoch.



1210
1211
1212
 
# File 'lib/stripe/params/quote_update_params.rb', line 1210

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF.



1212
1213
1214
 
# File 'lib/stripe/params/quote_update_params.rb', line 1212

def footer
  @footer
end

#header ⇒ Object

A header that will be displayed on the quote PDF.



1214
1215
1216
 
# File 'lib/stripe/params/quote_update_params.rb', line 1214

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1216
1217
1218
 
# File 'lib/stripe/params/quote_update_params.rb', line 1216

def invoice_settings
  @invoice_settings
end

#line_items ⇒ Object

A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.



1218
1219
1220
 
# File 'lib/stripe/params/quote_update_params.rb', line 1218

def line_items
  @line_items
end

#lines ⇒ Object

A list of [quote lines](docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.



1220
1221
1222
 
# File 'lib/stripe/params/quote_update_params.rb', line 1220

def lines
  @lines
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) 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`.



1222
1223
1224
 
# File 'lib/stripe/params/quote_update_params.rb', line 1222

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



1224
1225
1226
 
# File 'lib/stripe/params/quote_update_params.rb', line 1224

def on_behalf_of
  @on_behalf_of
end

#subscription_data ⇒ Object

When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if ‘subscription_data` is present and in the future, otherwise a subscription is created.



1226
1227
1228
 
# File 'lib/stripe/params/quote_update_params.rb', line 1226

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

List representing overrides for ‘subscription_data` configurations for specific subscription schedules.



1228
1229
1230
 
# File 'lib/stripe/params/quote_update_params.rb', line 1228

def subscription_data_overrides
  @subscription_data_overrides
end

#transfer_data ⇒ Object

The data with which to automatically create a Transfer for each of the invoices.



1230
1231
1232
 
# File 'lib/stripe/params/quote_update_params.rb', line 1230

def transfer_data
  @transfer_data
end