Class: Stripe::Tax::Registration

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/tax/registration.rb

Overview

A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.

Stripe doesn't register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide.

Related guide: Using the Registrations API

Defined Under Namespace

Classes: CountryOptions

Constant Summary collapse

OBJECT_NAME = 
"tax.registration"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, #_get_union_variant_class, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, inner_class_union_variant_types, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#active_from ⇒ Object (readonly)

Time at which the registration becomes active. Measured in seconds since the Unix epoch.



2653
2654
2655
 
# File 'lib/stripe/resources/tax/registration.rb', line 2653

def active_from
  @active_from
end

#country ⇒ Object (readonly)

Two-letter country code (ISO 3166-1 alpha-2).



2655
2656
2657
 
# File 'lib/stripe/resources/tax/registration.rb', line 2655

def country
  @country
end

#country_options ⇒ Object (readonly)

Attribute for field country_options



2657
2658
2659
 
# File 'lib/stripe/resources/tax/registration.rb', line 2657

def country_options
  @country_options
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



2659
2660
2661
 
# File 'lib/stripe/resources/tax/registration.rb', line 2659

def created
  @created
end

#expires_at ⇒ Object (readonly)

If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.



2661
2662
2663
 
# File 'lib/stripe/resources/tax/registration.rb', line 2661

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2663
2664
2665
 
# File 'lib/stripe/resources/tax/registration.rb', line 2663

def id
  @id
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



2665
2666
2667
 
# File 'lib/stripe/resources/tax/registration.rb', line 2665

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object's type. Objects of the same type share the same value.



2667
2668
2669
 
# File 'lib/stripe/resources/tax/registration.rb', line 2667

def object
  @object
end

#status ⇒ Object (readonly)

The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.



2669
2670
2671
 
# File 'lib/stripe/resources/tax/registration.rb', line 2669

def status
  @status
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a new Tax Registration object.



2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'lib/stripe/resources/tax/registration.rb', line 2672

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/tax/registrations",
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



2707
2708
2709
 
# File 'lib/stripe/resources/tax/registration.rb', line 2707

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



2703
2704
2705
 
# File 'lib/stripe/resources/tax/registration.rb', line 2703

def self.inner_class_types
  @inner_class_types = { country_options: CountryOptions }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of Tax Registration objects.



2682
2683
2684
2685
2686
2687
2688
2689
 
# File 'lib/stripe/resources/tax/registration.rb', line 2682

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/tax/registrations",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



17
18
19
 
# File 'lib/stripe/resources/tax/registration.rb', line 17

def self.object_name
  "tax.registration"
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.



2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/stripe/resources/tax/registration.rb', line 2694

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/tax/registrations/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end