Class: Stripe::Invoice::UpdateLinesParams::Line::TaxAmount::TaxRateData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(country: nil, description: nil, display_name: nil, inclusive: nil, jurisdiction: nil, jurisdiction_level: nil, percentage: nil, state: nil, tax_type: nil) ⇒ TaxRateData

Returns a new instance of TaxRateData.



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/stripe/resources/invoice.rb', line 2128

def initialize(
  country: nil,
  description: nil,
  display_name: nil,
  inclusive: nil,
  jurisdiction: nil,
  jurisdiction_level: nil,
  percentage: nil,
  state: nil,
  tax_type: nil
)
  @country = country
  @description = description
  @display_name = display_name
  @inclusive = inclusive
  @jurisdiction = jurisdiction
  @jurisdiction_level = jurisdiction_level
  @percentage = percentage
  @state = state
  @tax_type = tax_type
end

Instance Attribute Details

#country ⇒ Object

Two-letter country code ([ISO 3166-1 alpha-2](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).



2110
2111
2112
 
# File 'lib/stripe/resources/invoice.rb', line 2110

def country
  @country
end

#description ⇒ Object

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.



2112
2113
2114
 
# File 'lib/stripe/resources/invoice.rb', line 2112

def description
  @description
end

#display_name ⇒ Object

The display name of the tax rate, which will be shown to users.



2114
2115
2116
 
# File 'lib/stripe/resources/invoice.rb', line 2114

def display_name
  @display_name
end

#inclusive ⇒ Object

This specifies if the tax rate is inclusive or exclusive.



2116
2117
2118
 
# File 'lib/stripe/resources/invoice.rb', line 2116

def inclusive
  @inclusive
end

#jurisdiction ⇒ Object

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.



2118
2119
2120
 
# File 'lib/stripe/resources/invoice.rb', line 2118

def jurisdiction
  @jurisdiction
end

#jurisdiction_level ⇒ Object

The level of the jurisdiction that imposes this tax rate.



2120
2121
2122
 
# File 'lib/stripe/resources/invoice.rb', line 2120

def jurisdiction_level
  @jurisdiction_level
end

#percentage ⇒ Object

The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the ‘amount` of the tax is also zero.



2122
2123
2124
 
# File 'lib/stripe/resources/invoice.rb', line 2122

def percentage
  @percentage
end

#state ⇒ Object

[ISO 3166-2 subdivision code](en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, “NY” for New York, United States.



2124
2125
2126
 
# File 'lib/stripe/resources/invoice.rb', line 2124

def state
  @state
end

#tax_type ⇒ Object

The high-level tax type, such as ‘vat` or `sales_tax`.



2126
2127
2128
 
# File 'lib/stripe/resources/invoice.rb', line 2126

def tax_type
  @tax_type
end