Class: Stripe::Quote::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/quote.rb

Defined Under Namespace

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(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, header: nil, invoice_settings: nil, line_items: nil, metadata: nil, on_behalf_of: nil, subscription_data: nil, transfer_data: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/stripe/resources/quote.rb', line 748

def initialize(
  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,
  header: nil,
  invoice_settings: nil,
  line_items: nil,
  metadata: nil,
  on_behalf_of: nil,
  subscription_data: nil,
  transfer_data: nil
)
  @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
  @header = header
  @invoice_settings = invoice_settings
  @line_items = line_items
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @subscription_data = subscription_data
  @transfer_data = transfer_data
end

Instance Attribute Details

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



712
713
714
 
# File 'lib/stripe/resources/quote.rb', line 712

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.



714
715
716
 
# File 'lib/stripe/resources/quote.rb', line 714

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



716
717
718
 
# File 'lib/stripe/resources/quote.rb', line 716

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



718
719
720
 
# File 'lib/stripe/resources/quote.rb', line 718

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.



720
721
722
 
# File 'lib/stripe/resources/quote.rb', line 720

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.



722
723
724
 
# File 'lib/stripe/resources/quote.rb', line 722

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

A description that will be displayed on the quote PDF.



724
725
726
 
# File 'lib/stripe/resources/quote.rb', line 724

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



726
727
728
 
# File 'lib/stripe/resources/quote.rb', line 726

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



728
729
730
 
# File 'lib/stripe/resources/quote.rb', line 728

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.



730
731
732
 
# File 'lib/stripe/resources/quote.rb', line 730

def expires_at
  @expires_at
end

#footer ⇒ Object

A footer that will be displayed on the quote PDF.



732
733
734
 
# File 'lib/stripe/resources/quote.rb', line 732

def footer
  @footer
end

#header ⇒ Object

A header that will be displayed on the quote PDF.



734
735
736
 
# File 'lib/stripe/resources/quote.rb', line 734

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



736
737
738
 
# File 'lib/stripe/resources/quote.rb', line 736

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.



738
739
740
 
# File 'lib/stripe/resources/quote.rb', line 738

def line_items
  @line_items
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`.



740
741
742
 
# File 'lib/stripe/resources/quote.rb', line 740

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



742
743
744
 
# File 'lib/stripe/resources/quote.rb', line 742

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.



744
745
746
 
# File 'lib/stripe/resources/quote.rb', line 744

def subscription_data
  @subscription_data
end

#transfer_data ⇒ Object

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



746
747
748
 
# File 'lib/stripe/resources/quote.rb', line 746

def transfer_data
  @transfer_data
end