Class: Stripe::Quote::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/quote.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.



3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'lib/stripe/resources/quote.rb', line 3030

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.



2986
2987
2988
 
# File 'lib/stripe/resources/quote.rb', line 2986

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.



2988
2989
2990
 
# File 'lib/stripe/resources/quote.rb', line 2988

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.



2990
2991
2992
 
# File 'lib/stripe/resources/quote.rb', line 2990

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



2992
2993
2994
 
# File 'lib/stripe/resources/quote.rb', line 2992

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



2994
2995
2996
 
# File 'lib/stripe/resources/quote.rb', line 2994

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.



2996
2997
2998
 
# File 'lib/stripe/resources/quote.rb', line 2996

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.



2998
2999
3000
 
# File 'lib/stripe/resources/quote.rb', line 2998

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.



3000
3001
3002
 
# File 'lib/stripe/resources/quote.rb', line 3000

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF.



3002
3003
3004
 
# File 'lib/stripe/resources/quote.rb', line 3002

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



3004
3005
3006
 
# File 'lib/stripe/resources/quote.rb', line 3004

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



3006
3007
3008
 
# File 'lib/stripe/resources/quote.rb', line 3006

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.



3008
3009
3010
 
# File 'lib/stripe/resources/quote.rb', line 3008

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF.



3010
3011
3012
 
# File 'lib/stripe/resources/quote.rb', line 3010

def footer
  @footer
end

#header ⇒ Object

A header that will be displayed on the quote PDF.



3012
3013
3014
 
# File 'lib/stripe/resources/quote.rb', line 3012

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



3014
3015
3016
 
# File 'lib/stripe/resources/quote.rb', line 3014

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.



3016
3017
3018
 
# File 'lib/stripe/resources/quote.rb', line 3016

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.



3018
3019
3020
 
# File 'lib/stripe/resources/quote.rb', line 3018

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



3020
3021
3022
 
# File 'lib/stripe/resources/quote.rb', line 3020

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



3022
3023
3024
 
# File 'lib/stripe/resources/quote.rb', line 3022

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.



3024
3025
3026
 
# File 'lib/stripe/resources/quote.rb', line 3024

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

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



3026
3027
3028
 
# File 'lib/stripe/resources/quote.rb', line 3026

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.



3028
3029
3030
 
# File 'lib/stripe/resources/quote.rb', line 3028

def transfer_data
  @transfer_data
end