Class: Stripe::Invoice::AddLinesParams::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.



2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
 
# File 'lib/stripe/resources/invoice.rb', line 2501

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



2483
2484
2485
 
# File 'lib/stripe/resources/invoice.rb', line 2483

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.



2485
2486
2487
 
# File 'lib/stripe/resources/invoice.rb', line 2485

def description
  @description
end

#display_name ⇒ Object

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



2487
2488
2489
 
# File 'lib/stripe/resources/invoice.rb', line 2487

def display_name
  @display_name
end

#inclusive ⇒ Object

This specifies if the tax rate is inclusive or exclusive.



2489
2490
2491
 
# File 'lib/stripe/resources/invoice.rb', line 2489

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.



2491
2492
2493
 
# File 'lib/stripe/resources/invoice.rb', line 2491

def jurisdiction
  @jurisdiction
end

#jurisdiction_level ⇒ Object

The level of the jurisdiction that imposes this tax rate.



2493
2494
2495
 
# File 'lib/stripe/resources/invoice.rb', line 2493

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.



2495
2496
2497
 
# File 'lib/stripe/resources/invoice.rb', line 2495

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.



2497
2498
2499
 
# File 'lib/stripe/resources/invoice.rb', line 2497

def state
  @state
end

#tax_type ⇒ Object

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



2499
2500
2501
 
# File 'lib/stripe/resources/invoice.rb', line 2499

def tax_type
  @tax_type
end