Class: Stripe::QuoteCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/quote_create_params.rb

Defined Under Namespace

Classes: AutomaticTax, Discount, FromQuote, 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, 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) ⇒ QuoteCreateParams

Returns a new instance of QuoteCreateParams.



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/stripe/params/quote_create_params.rb', line 1069

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,
  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
  @customer_account = 
  @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.



1021
1022
1023
 
# File 'lib/stripe/params/quote_create_params.rb', line 1021

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.



1023
1024
1025
 
# File 'lib/stripe/params/quote_create_params.rb', line 1023

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.



1025
1026
1027
 
# File 'lib/stripe/params/quote_create_params.rb', line 1025

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

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



1027
1028
1029
 
# File 'lib/stripe/params/quote_create_params.rb', line 1027

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



1029
1030
1031
 
# File 'lib/stripe/params/quote_create_params.rb', line 1029

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.



1031
1032
1033
 
# File 'lib/stripe/params/quote_create_params.rb', line 1031

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.



1033
1034
1035
 
# File 'lib/stripe/params/quote_create_params.rb', line 1033

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.



1035
1036
1037
 
# File 'lib/stripe/params/quote_create_params.rb', line 1035

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.



1037
1038
1039
 
# File 'lib/stripe/params/quote_create_params.rb', line 1037

def description
  @description
end

#discounts ⇒ Object

The discounts applied to the quote.



1039
1040
1041
 
# File 'lib/stripe/params/quote_create_params.rb', line 1039

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1041
1042
1043
 
# File 'lib/stripe/params/quote_create_params.rb', line 1041

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.



1043
1044
1045
 
# File 'lib/stripe/params/quote_create_params.rb', line 1043

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.



1045
1046
1047
 
# File 'lib/stripe/params/quote_create_params.rb', line 1045

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



1047
1048
1049
 
# File 'lib/stripe/params/quote_create_params.rb', line 1047

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.



1049
1050
1051
 
# File 'lib/stripe/params/quote_create_params.rb', line 1049

def header
  @header
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1051
1052
1053
 
# File 'lib/stripe/params/quote_create_params.rb', line 1051

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.



1053
1054
1055
 
# File 'lib/stripe/params/quote_create_params.rb', line 1053

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.



1055
1056
1057
 
# File 'lib/stripe/params/quote_create_params.rb', line 1055

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



1057
1058
1059
 
# File 'lib/stripe/params/quote_create_params.rb', line 1057

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



1059
1060
1061
 
# File 'lib/stripe/params/quote_create_params.rb', line 1059

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.



1061
1062
1063
 
# File 'lib/stripe/params/quote_create_params.rb', line 1061

def subscription_data
  @subscription_data
end

#subscription_data_overrides ⇒ Object

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



1063
1064
1065
 
# File 'lib/stripe/params/quote_create_params.rb', line 1063

def subscription_data_overrides
  @subscription_data_overrides
end

#test_clock ⇒ Object

ID of the test clock to attach to the quote.



1065
1066
1067
 
# File 'lib/stripe/params/quote_create_params.rb', line 1065

def test_clock
  @test_clock
end

#transfer_data ⇒ Object

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



1067
1068
1069
 
# File 'lib/stripe/params/quote_create_params.rb', line 1067

def transfer_data
  @transfer_data
end

Class Method Details

.field_encodings ⇒ Object 



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'lib/stripe/params/quote_create_params.rb', line 1121

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