Class: Stripe::InvoiceCreatePreviewParams

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

Defined Under Namespace

Classes: AutomaticTax, CustomerDetails, Discount, InvoiceItem, Issuer, ScheduleDetails, SubscriptionDetails

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(automatic_tax: nil, currency: nil, customer: nil, customer_account: nil, customer_details: nil, discounts: nil, expand: nil, invoice_items: nil, issuer: nil, on_behalf_of: nil, preview_mode: nil, schedule: nil, schedule_details: nil, subscription: nil, subscription_details: nil) ⇒ InvoiceCreatePreviewParams

Returns a new instance of InvoiceCreatePreviewParams.



1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1971

def initialize(
  automatic_tax: nil,
  currency: nil,
  customer: nil,
  customer_account: nil,
  customer_details: nil,
  discounts: nil,
  expand: nil,
  invoice_items: nil,
  issuer: nil,
  on_behalf_of: nil,
  preview_mode: nil,
  schedule: nil,
  schedule_details: nil,
  subscription: nil,
  subscription_details: nil
)
  @automatic_tax = automatic_tax
  @currency = currency
  @customer = customer
  @customer_account = 
  @customer_details = customer_details
  @discounts = discounts
  @expand = expand
  @invoice_items = invoice_items
  @issuer = issuer
  @on_behalf_of = on_behalf_of
  @preview_mode = preview_mode
  @schedule = schedule
  @schedule_details = schedule_details
  @subscription = subscription
  @subscription_details = subscription_details
end

Instance Attribute Details

#automatic_tax ⇒ Object

Settings for automatic tax lookup for this invoice preview.



1941
1942
1943
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1941

def automatic_tax
  @automatic_tax
end

#currency ⇒ Object

The currency to preview this invoice in. Defaults to that of customer if not specified.



1943
1944
1945
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1943

def currency
  @currency
end

#customer ⇒ Object

The identifier of the customer whose upcoming invoice you're retrieving. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.



1945
1946
1947
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1945

def customer
  @customer
end

#customer_account ⇒ Object

The identifier of the account representing the customer whose upcoming invoice you're retrieving. If automatic_tax is enabled then one of customer, customer_account, customer_details, subscription, or schedule must be set.



1947
1948
1949
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1947

def 
  @customer_account
end

#customer_details ⇒ Object

Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.



1949
1950
1951
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1949

def customer_details
  @customer_details
end

#discounts ⇒ Object

The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.



1951
1952
1953
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1951

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1953
1954
1955
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1953

def expand
  @expand
end

#invoice_items ⇒ Object

List of invoice items to add or update in the upcoming invoice preview (up to 250).



1955
1956
1957
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1955

def invoice_items
  @invoice_items
end

#issuer ⇒ Object

The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.



1957
1958
1959
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1957

def issuer
  @issuer
end

#on_behalf_of ⇒ Object

The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.



1959
1960
1961
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1959

def on_behalf_of
  @on_behalf_of
end

#preview_mode ⇒ Object

Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified.



1961
1962
1963
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1961

def preview_mode
  @preview_mode
end

#schedule ⇒ Object

The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.



1963
1964
1965
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1963

def schedule
  @schedule
end

#schedule_details ⇒ Object

The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields.



1965
1966
1967
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1965

def schedule_details
  @schedule_details
end

#subscription ⇒ Object

The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.



1967
1968
1969
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1967

def subscription
  @subscription
end

#subscription_details ⇒ Object

The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields.



1969
1970
1971
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1969

def subscription_details
  @subscription_details
end

Class Method Details

.field_encodings ⇒ Object 



2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 2005

def self.field_encodings
  @field_encodings = {
    invoice_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: {
          price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
          quantity_decimal: :decimal_string,
          unit_amount_decimal: :decimal_string,
        },
      },
    },
    schedule_details: {
      kind: :object,
      fields: {
        phases: {
          kind: :array,
          element: {
            kind: :object,
            fields: {
              add_invoice_items: {
                kind: :array,
                element: {
                  kind: :object,
                  fields: {
                    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
                  },
                },
              },
              items: {
                kind: :array,
                element: {
                  kind: :object,
                  fields: {
                    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
                  },
                },
              },
            },
          },
        },
      },
    },
    subscription_details: {
      kind: :object,
      fields: {
        items: {
          kind: :array,
          element: {
            kind: :object,
            fields: {
              price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
            },
          },
        },
      },
    },
  }
end