Class: Stripe::QuoteService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/quote_service.rb

Defined Under Namespace

Classes: AutomaticTax, Discount, FromQuote, 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, default_tax_rates: nil, description: nil, discounts: nil, expand: nil, expires_at: nil, footer: nil, from_quote: nil, header: nil, invoice_settings: nil, line_items: nil, lines: nil, metadata: nil, on_behalf_of: nil, subscription_data: nil, subscription_data_overrides: nil, test_clock: nil, transfer_data: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



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
1279
1280
1281
 
# File 'lib/stripe/services/quote_service.rb', line 1233

def initialize(
  allow_backdated_lines: nil,
  application_fee_amount: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  collection_method: nil,
  customer: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  expand: nil,
  expires_at: nil,
  footer: nil,
  from_quote: nil,
  header: nil,
  invoice_settings: nil,
  line_items: nil,
  lines: nil,
  metadata: nil,
  on_behalf_of: nil,
  subscription_data: nil,
  subscription_data_overrides: nil,
  test_clock: 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
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @expand = expand
  @expires_at = expires_at
  @footer = footer
  @from_quote = from_quote
  @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
  @test_clock = test_clock
  @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.



1165
1166
1167
 
# File 'lib/stripe/services/quote_service.rb', line 1165

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.



1168
1169
1170
 
# File 'lib/stripe/services/quote_service.rb', line 1168

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.



1171
1172
1173
 
# File 'lib/stripe/services/quote_service.rb', line 1171

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



1174
1175
1176
 
# File 'lib/stripe/services/quote_service.rb', line 1174

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



1177
1178
1179
 
# File 'lib/stripe/services/quote_service.rb', line 1177

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.



1180
1181
1182
 
# File 'lib/stripe/services/quote_service.rb', line 1180

def customer
  @customer
end

#default_tax_rates ⇒ Object

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



1183
1184
1185
 
# File 'lib/stripe/services/quote_service.rb', line 1183

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](dashboard.stripe.com/settings/billing/quote) will be used.



1186
1187
1188
 
# File 'lib/stripe/services/quote_service.rb', line 1186

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



1189
1190
1191
 
# File 'lib/stripe/services/quote_service.rb', line 1189

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1192
1193
1194
 
# File 'lib/stripe/services/quote_service.rb', line 1192

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. If no value is passed, the default expiration date configured in your [quote template settings](dashboard.stripe.com/settings/billing/quote) will be used.



1195
1196
1197
 
# File 'lib/stripe/services/quote_service.rb', line 1195

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](dashboard.stripe.com/settings/billing/quote) will be used.



1198
1199
1200
 
# File 'lib/stripe/services/quote_service.rb', line 1198

def footer
  @footer
end

#from_quote ⇒ Object

Clone an existing quote. The new quote will be created in ‘status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.



1201
1202
1203
 
# File 'lib/stripe/services/quote_service.rb', line 1201

def from_quote
  @from_quote
end

#header ⇒ Object

A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](dashboard.stripe.com/settings/billing/quote) will be used.



1204
1205
1206
 
# File 'lib/stripe/services/quote_service.rb', line 1204

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1207
1208
1209
 
# File 'lib/stripe/services/quote_service.rb', line 1207

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.



1210
1211
1212
 
# File 'lib/stripe/services/quote_service.rb', line 1210

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.



1213
1214
1215
 
# File 'lib/stripe/services/quote_service.rb', line 1213

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



1216
1217
1218
 
# File 'lib/stripe/services/quote_service.rb', line 1216

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



1219
1220
1221
 
# File 'lib/stripe/services/quote_service.rb', line 1219

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.



1222
1223
1224
 
# File 'lib/stripe/services/quote_service.rb', line 1222

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

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



1225
1226
1227
 
# File 'lib/stripe/services/quote_service.rb', line 1225

def subscription_data_overrides
  @subscription_data_overrides
end

#test_clock ⇒ Object

ID of the test clock to attach to the quote.



1228
1229
1230
 
# File 'lib/stripe/services/quote_service.rb', line 1228

def test_clock
  @test_clock
end

#transfer_data ⇒ Object

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



1231
1232
1233
 
# File 'lib/stripe/services/quote_service.rb', line 1231

def transfer_data
  @transfer_data
end