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.com/docs/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](stripe.com/docs/tax/registering).

Related guide: [Using the Registrations API](stripe.com/docs/tax/registrations-api)

Defined Under Namespace

Classes: CountryOptions, CreateParams, ListParams, UpdateParams

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

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #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.



2616
2617
2618
 
# File 'lib/stripe/resources/tax/registration.rb', line 2616

def active_from
  @active_from
end

#country ⇒ Object (readonly)

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



2618
2619
2620
 
# File 'lib/stripe/resources/tax/registration.rb', line 2618

def country
  @country
end

#country_options ⇒ Object (readonly)

Attribute for field country_options



2620
2621
2622
 
# File 'lib/stripe/resources/tax/registration.rb', line 2620

def country_options
  @country_options
end

#created ⇒ Object (readonly)

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



2622
2623
2624
 
# File 'lib/stripe/resources/tax/registration.rb', line 2622

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.



2624
2625
2626
 
# File 'lib/stripe/resources/tax/registration.rb', line 2624

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2626
2627
2628
 
# File 'lib/stripe/resources/tax/registration.rb', line 2626

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



2628
2629
2630
 
# File 'lib/stripe/resources/tax/registration.rb', line 2628

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



2630
2631
2632
 
# File 'lib/stripe/resources/tax/registration.rb', line 2630

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



2632
2633
2634
 
# File 'lib/stripe/resources/tax/registration.rb', line 2632

def status
  @status
end

Class Method Details

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

Creates a new Tax Registration object.



2635
2636
2637
2638
2639
2640
2641
2642
 
# File 'lib/stripe/resources/tax/registration.rb', line 2635

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

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

Returns a list of Tax Registration objects.



2645
2646
2647
2648
2649
2650
2651
2652
 
# File 'lib/stripe/resources/tax/registration.rb', line 2645

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.



2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/stripe/resources/tax/registration.rb', line 2657

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