Class: Stripe::QuoteService::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/quote_service.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) ⇒ UpdateParams

Returns a new instance of UpdateParams.



2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
 
# File 'lib/stripe/services/quote_service.rb', line 2177

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.



2133
2134
2135
 
# File 'lib/stripe/services/quote_service.rb', line 2133

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.



2135
2136
2137
 
# File 'lib/stripe/services/quote_service.rb', line 2135

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.



2137
2138
2139
 
# File 'lib/stripe/services/quote_service.rb', line 2137

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



2139
2140
2141
 
# File 'lib/stripe/services/quote_service.rb', line 2139

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



2141
2142
2143
 
# File 'lib/stripe/services/quote_service.rb', line 2141

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.



2143
2144
2145
 
# File 'lib/stripe/services/quote_service.rb', line 2143

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.



2145
2146
2147
 
# File 'lib/stripe/services/quote_service.rb', line 2145

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.



2147
2148
2149
 
# File 'lib/stripe/services/quote_service.rb', line 2147

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF.



2149
2150
2151
 
# File 'lib/stripe/services/quote_service.rb', line 2149

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



2151
2152
2153
 
# File 'lib/stripe/services/quote_service.rb', line 2151

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



2153
2154
2155
 
# File 'lib/stripe/services/quote_service.rb', line 2153

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.



2155
2156
2157
 
# File 'lib/stripe/services/quote_service.rb', line 2155

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF.



2157
2158
2159
 
# File 'lib/stripe/services/quote_service.rb', line 2157

def footer
  @footer
end

#header ⇒ Object

A header that will be displayed on the quote PDF.



2159
2160
2161
 
# File 'lib/stripe/services/quote_service.rb', line 2159

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



2161
2162
2163
 
# File 'lib/stripe/services/quote_service.rb', line 2161

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.



2163
2164
2165
 
# File 'lib/stripe/services/quote_service.rb', line 2163

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.



2165
2166
2167
 
# File 'lib/stripe/services/quote_service.rb', line 2165

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



2167
2168
2169
 
# File 'lib/stripe/services/quote_service.rb', line 2167

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



2169
2170
2171
 
# File 'lib/stripe/services/quote_service.rb', line 2169

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.



2171
2172
2173
 
# File 'lib/stripe/services/quote_service.rb', line 2171

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

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



2173
2174
2175
 
# File 'lib/stripe/services/quote_service.rb', line 2173

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.



2175
2176
2177
 
# File 'lib/stripe/services/quote_service.rb', line 2175

def transfer_data
  @transfer_data
end