Class: Stripe::TaxRateCreateParams

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, country: nil, description: nil, display_name: nil, expand: nil, inclusive: nil, jurisdiction: nil, metadata: nil, percentage: nil, state: nil, tax_type: nil) ⇒ TaxRateCreateParams

Returns a new instance of TaxRateCreateParams.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 29

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

Instance Attribute Details

#active ⇒ Object

Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.



7
8
9
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 7

def active
  @active
end

#country ⇒ Object

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



9
10
11
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 9

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.



11
12
13
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 11

def description
  @description
end

#display_name ⇒ Object

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



13
14
15
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 13

def display_name
  @display_name
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



15
16
17
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 15

def expand
  @expand
end

#inclusive ⇒ Object

This specifies if the tax rate is inclusive or exclusive.



17
18
19
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 17

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.



19
20
21
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 19

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



21
22
23
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 21

def metadata
  @metadata
end

#percentage ⇒ Object

This represents the tax rate percent out of 100.



23
24
25
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 23

def percentage
  @percentage
end

#state ⇒ Object

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



25
26
27
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 25

def state
  @state
end

#tax_type ⇒ Object

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



27
28
29
 
# File 'lib/stripe/params/tax_rate_create_params.rb', line 27

def tax_type
  @tax_type
end