class Stripe::TaxTransaction

Overview

A Tax Transaction records the tax collected from or refunded to your customer. Related guide: Calculate tax in your custom payment flow

Included Modules

Defined in:

stripe/models/tax_transaction.cr

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [reversal, transaction]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [tax.transaction]."
MAX_LENGTH_FOR_CURRENCY = 5000
MAX_LENGTH_FOR_CUSTOMER = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_REFERENCE = 5000
VALID_VALUES_FOR__TYPE = String.static_array("reversal", "transaction")
VALID_VALUES_FOR_OBJECT = String.static_array("tax.transaction")

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::TaxProductResourceCustomerDetails | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, posted_at : Int64 | Nil = nil, reference : String | Nil = nil, reversal : Stripe::TaxTransactionReversal | Nil = nil, ship_from_details : Stripe::TaxCalculationShipFromDetails | Nil = nil, shipping_cost : Stripe::TaxTransactionShippingCost | Nil = nil, tax_date : Int64 | Nil = nil, _type : String | Nil = nil, line_items : Stripe::TaxProductResourceTaxTransactionLineItemList | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def _type : String | Nil #

[View source]
def _type=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned


[View source]
def currency : String | Nil #

[View source]
def currency=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned


[View source]
def customer : String | Nil #

[View source]
def customer=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned


[View source]
def customer_details : Stripe::TaxProductResourceCustomerDetails | Nil #

[View source]
def customer_details=(new_value : Stripe::TaxProductResourceCustomerDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] customer_details Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned


[View source]

[View source]
def line_items=(new_value : Stripe::TaxProductResourceTaxTransactionLineItemList | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] line_items Object to be assigned


[View source]
def line_items_present=(line_items_present : Bool) #

[View source]
def line_items_present? : Bool #

[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned


[View source]
def posted_at : Int64 | Nil #

[View source]
def posted_at=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] posted_at Object to be assigned


[View source]
def reference : String | Nil #

[View source]
def reference=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] reference Object to be assigned


[View source]
def reversal : Stripe::TaxTransactionReversal | Nil #

[View source]
def reversal=(new_value : Stripe::TaxTransactionReversal | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] reversal Object to be assigned


[View source]
def ship_from_details : Stripe::TaxCalculationShipFromDetails | Nil #

[View source]
def ship_from_details=(new_value : Stripe::TaxCalculationShipFromDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] ship_from_details Object to be assigned


[View source]
def shipping_cost : Stripe::TaxTransactionShippingCost | Nil #

[View source]
def shipping_cost=(new_value : Stripe::TaxTransactionShippingCost | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] shipping_cost Object to be assigned


[View source]
def tax_date : Int64 | Nil #

[View source]
def tax_date=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] tax_date Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]