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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #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.



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/stripe/params/quote_update_params.rb', line 1450

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.



1406
1407
1408
 
# File 'lib/stripe/params/quote_update_params.rb', line 1406

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.



1408
1409
1410
 
# File 'lib/stripe/params/quote_update_params.rb', line 1408

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.



1410
1411
1412
 
# File 'lib/stripe/params/quote_update_params.rb', line 1410

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



1412
1413
1414
 
# File 'lib/stripe/params/quote_update_params.rb', line 1412

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



1414
1415
1416
 
# File 'lib/stripe/params/quote_update_params.rb', line 1414

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.



1416
1417
1418
 
# File 'lib/stripe/params/quote_update_params.rb', line 1416

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.



1418
1419
1420
 
# File 'lib/stripe/params/quote_update_params.rb', line 1418

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.



1420
1421
1422
 
# File 'lib/stripe/params/quote_update_params.rb', line 1420

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF.



1422
1423
1424
 
# File 'lib/stripe/params/quote_update_params.rb', line 1422

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



1424
1425
1426
 
# File 'lib/stripe/params/quote_update_params.rb', line 1424

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1426
1427
1428
 
# File 'lib/stripe/params/quote_update_params.rb', line 1426

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.



1428
1429
1430
 
# File 'lib/stripe/params/quote_update_params.rb', line 1428

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF.



1430
1431
1432
 
# File 'lib/stripe/params/quote_update_params.rb', line 1430

def footer
  @footer
end

#header ⇒ Object

A header that will be displayed on the quote PDF.



1432
1433
1434
 
# File 'lib/stripe/params/quote_update_params.rb', line 1432

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1434
1435
1436
 
# File 'lib/stripe/params/quote_update_params.rb', line 1434

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.



1436
1437
1438
 
# File 'lib/stripe/params/quote_update_params.rb', line 1436

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.



1438
1439
1440
 
# File 'lib/stripe/params/quote_update_params.rb', line 1438

def lines
  @lines
end

#metadata ⇒ Object

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



1440
1441
1442
 
# File 'lib/stripe/params/quote_update_params.rb', line 1440

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



1442
1443
1444
 
# File 'lib/stripe/params/quote_update_params.rb', line 1442

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.



1444
1445
1446
 
# File 'lib/stripe/params/quote_update_params.rb', line 1444

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

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



1446
1447
1448
 
# File 'lib/stripe/params/quote_update_params.rb', line 1446

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.



1448
1449
1450
 
# File 'lib/stripe/params/quote_update_params.rb', line 1448

def transfer_data
  @transfer_data
end

Class Method Details

.field_encodings ⇒ Object 



1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'lib/stripe/params/quote_update_params.rb', line 1498

def self.field_encodings
  @field_encodings = {
    line_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: { price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } } },
      },
    },
  }
end