class Stripe::TaxApi

Defined in:

stripe/api/tax_api.cr

Constant Summary

GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMS_MAX_LENGTH_FOR_CALCULATION = 5000
GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMS_MAX_LENGTH_FOR_ENDING_BEFORE = 500
GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMS_MAX_LENGTH_FOR_STARTING_AFTER = 500
GET_TAX_REGISTRATIONS_ID_MAX_LENGTH_FOR_ID = 5000
GET_TAX_REGISTRATIONS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_TAX_REGISTRATIONS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_TAX_REGISTRATIONS_VALID_VALUES_FOR_STATUS = String.static_array("active", "all", "expired", "scheduled")
GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMS_MAX_LENGTH_FOR_ENDING_BEFORE = 500
GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMS_MAX_LENGTH_FOR_STARTING_AFTER = 500
GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMS_MAX_LENGTH_FOR_TRANSACTION = 5000
GET_TAX_TRANSACTIONS_TRANSACTION_MAX_LENGTH_FOR_TRANSACTION = 5000
POST_TAX_CALCULATIONS_MAX_LENGTH_FOR_CUSTOMER = 5000
POST_TAX_REGISTRATIONS_ID_MAX_LENGTH_FOR_ID = 5000
POST_TAX_REGISTRATIONS_MAX_LENGTH_FOR_COUNTRY = 5000
POST_TAX_TRANSACTIONS_CREATE_FROM_CALCULATION_MAX_LENGTH_FOR_CALCULATION = 5000
POST_TAX_TRANSACTIONS_CREATE_FROM_CALCULATION_MAX_LENGTH_FOR_REFERENCE = 500
POST_TAX_TRANSACTIONS_CREATE_REVERSAL_MAX_LENGTH_FOR_ORIGINAL_TRANSACTION = 5000
POST_TAX_TRANSACTIONS_CREATE_REVERSAL_MAX_LENGTH_FOR_REFERENCE = 500
POST_TAX_TRANSACTIONS_CREATE_REVERSAL_VALID_VALUES_FOR_MODE = String.static_array("full", "partial")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_get_tax_calculations_calculation_line_items(*, calculation : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_registrations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, status : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_registrations_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_settings(*, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_transactions_transaction_line_items(*, transaction : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_calculations(*, currency : String | Nil = nil, line_items : Array(Stripe::CalculationLineItem) | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::CustomerDetails | Nil = nil, expand : Array(String) | Nil = nil, ship_from_details : Stripe::ShipFromDetails | Nil = nil, shipping_cost : Stripe::ShippingCost | Nil = nil, tax_date : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_registrations(*, active_from : Stripe::PostTaxRegistrationsRequestActiveFrom | Nil = nil, country : String | Nil = nil, country_options : Stripe::CountryOptions | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_registrations_id(*, id : String | Nil = nil, active_from : Stripe::PostTaxRegistrationsIdRequestActiveFrom | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostTaxRegistrationsIdRequestExpiresAt | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_settings(*, defaults : Stripe::DefaultsParam | Nil = nil, expand : Array(String) | Nil = nil, head_office : Stripe::HeadOfficeParam | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_transactions_create_from_calculation(*, calculation : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, posted_at : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_transactions_create_reversal(*, mode : String | Nil = nil, original_transaction : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, flat_amount : Int64 | Nil = nil, line_items : Array(Stripe::TransactionLineItemReversal) | Nil = nil, metadata : Hash(String, String) | Nil = nil, shipping_cost : Stripe::TransactionShippingCostReversal | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def get_tax_calculations_calculation_line_items(*, calculation : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxProductResourceTaxCalculationLineItemList #

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

@required @param calculation [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxProductResourceTaxCalculationLineItemList]

[View source]
def get_tax_calculations_calculation_line_items(*, calculation : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.</p> @required @param calculation [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_calculations_calculation_line_items_with_http_info(*, calculation : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxProductResourceTaxCalculationLineItemList, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.</p> @required @param calculation [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxProductResourceTaxCalculationLineItemList, Integer, Hash)] Stripe::TaxProductResourceTaxCalculationLineItemList, response status code and response headers


[View source]
def get_tax_registrations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, status : String | Nil = nil) : Stripe::TaxProductRegistrationsResourceTaxRegistrationList #

Returns a list of Tax Registration objects.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param status [String?] The status of the Tax Registration. @return [Stripe::TaxProductRegistrationsResourceTaxRegistrationList]

[View source]
def get_tax_registrations(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, status : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of Tax <code>Registration</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param status [String?] The status of the Tax Registration. @return nil


[View source]
def get_tax_registrations_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxRegistration #

Returns a Tax Registration object.

@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxRegistration]

[View source]
def get_tax_registrations_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a Tax <code>Registration</code> object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_registrations_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxRegistration, Int32, Hash(String, Array(String) | String)) #

<p>Returns a Tax <code>Registration</code> object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxRegistration, Integer, Hash)] Stripe::TaxRegistration, response status code and response headers


[View source]
def get_tax_registrations_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, status : String | Nil = nil) : Tuple(Stripe::TaxProductRegistrationsResourceTaxRegistrationList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of Tax <code>Registration</code> objects.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param status [String?] The status of the Tax Registration. @return [Tuple(Stripe::TaxProductRegistrationsResourceTaxRegistrationList, Integer, Hash)] Stripe::TaxProductRegistrationsResourceTaxRegistrationList, response status code and response headers


[View source]
def get_tax_settings(*, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxSettings #

Retrieves Tax Settings for a merchant.

@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxSettings]

[View source]
def get_tax_settings(*, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves Tax <code>Settings</code> for a merchant.</p> @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_settings_with_http_info(*, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxSettings, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves Tax <code>Settings</code> for a merchant.</p> @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxSettings, Integer, Hash)] Stripe::TaxSettings, response status code and response headers


[View source]
def get_tax_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxTransaction #

Retrieves a Tax Transaction object.

@required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxTransaction]

[View source]
def get_tax_transactions_transaction(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a Tax <code>Transaction</code> object.</p> @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_transactions_transaction_line_items(*, transaction : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxProductResourceTaxTransactionLineItemList #

Retrieves the line items of a committed standalone transaction as a collection.

@required @param transaction [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxProductResourceTaxTransactionLineItemList]

[View source]
def get_tax_transactions_transaction_line_items(*, transaction : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves the line items of a committed standalone transaction as a collection.</p> @required @param transaction [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_transactions_transaction_line_items_with_http_info(*, transaction : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxProductResourceTaxTransactionLineItemList, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves the line items of a committed standalone transaction as a collection.</p> @required @param transaction [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxProductResourceTaxTransactionLineItemList, Integer, Hash)] Stripe::TaxProductResourceTaxTransactionLineItemList, response status code and response headers


[View source]
def get_tax_transactions_transaction_with_http_info(*, transaction : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a Tax <code>Transaction</code> object.</p> @required @param transaction [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxTransaction, Integer, Hash)] Stripe::TaxTransaction, response status code and response headers


[View source]
def post_tax_calculations(*, currency : String | Nil = nil, line_items : Array(Stripe::CalculationLineItem) | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::CustomerDetails | Nil = nil, expand : Array(String) | Nil = nil, ship_from_details : Stripe::ShipFromDetails | Nil = nil, shipping_cost : Stripe::ShippingCost | Nil = nil, tax_date : Int64 | Nil = nil) : Stripe::TaxCalculation #

Calculates tax based on the input and returns a Tax Calculation object.

@required @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @required @param line_items [Array(Stripe::CalculationLineItem)?] A list of items the customer is purchasing. @optional @param customer [String?] The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. @optional @param customer_details [Stripe::CustomerDetails?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param ship_from_details [Stripe::ShipFromDetails?] @optional @param shipping_cost [Stripe::ShippingCost?] @optional @param tax_date [Int32?] Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. @return [Stripe::TaxCalculation]

[View source]
def post_tax_calculations(*, currency : String | Nil = nil, line_items : Array(Stripe::CalculationLineItem) | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::CustomerDetails | Nil = nil, expand : Array(String) | Nil = nil, ship_from_details : Stripe::ShipFromDetails | Nil = nil, shipping_cost : Stripe::ShippingCost | Nil = nil, tax_date : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Calculates tax based on the input and returns a Tax <code>Calculation</code> object.</p> @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param line_items [Array(Stripe::CalculationLineItem)?] A list of items the customer is purchasing. @optional @param customer [String?] The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to customer_details. @optional @param customer_details [Stripe::CustomerDetails?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param ship_from_details [Stripe::ShipFromDetails?] @optional @param shipping_cost [Stripe::ShippingCost?] @optional @param tax_date [Int32?] Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. @return nil


[View source]
def post_tax_calculations_with_http_info(*, currency : String | Nil = nil, line_items : Array(Stripe::CalculationLineItem) | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::CustomerDetails | Nil = nil, expand : Array(String) | Nil = nil, ship_from_details : Stripe::ShipFromDetails | Nil = nil, shipping_cost : Stripe::ShippingCost | Nil = nil, tax_date : Int64 | Nil = nil) : Tuple(Stripe::TaxCalculation, Int32, Hash(String, Array(String) | String)) #

<p>Calculates tax based on the input and returns a Tax <code>Calculation</code> object.</p> @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param line_items [Array(Stripe::CalculationLineItem)?] A list of items the customer is purchasing. @optional @param customer [String?] The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to customer_details. @optional @param customer_details [Stripe::CustomerDetails?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param ship_from_details [Stripe::ShipFromDetails?] @optional @param shipping_cost [Stripe::ShippingCost?] @optional @param tax_date [Int32?] Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. @return [Tuple(Stripe::TaxCalculation, Integer, Hash)] Stripe::TaxCalculation, response status code and response headers


[View source]
def post_tax_registrations(*, active_from : Stripe::PostTaxRegistrationsRequestActiveFrom | Nil = nil, country : String | Nil = nil, country_options : Stripe::CountryOptions | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Stripe::TaxRegistration #

Creates a new Tax Registration object.

@required @param active_from [Stripe::PostTaxRegistrationsRequestActiveFrom?] @required @param country [String?] Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). @required @param country_options [Stripe::CountryOptions?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. @return [Stripe::TaxRegistration]

[View source]
def post_tax_registrations(*, active_from : Stripe::PostTaxRegistrationsRequestActiveFrom | Nil = nil, country : String | Nil = nil, country_options : Stripe::CountryOptions | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a new Tax <code>Registration</code> object.</p> @required @param active_from [Stripe::PostTaxRegistrationsRequestActiveFrom?] @required @param country [String?] Two-letter country code (ISO 3166-1 alpha-2). @required @param country_options [Stripe::CountryOptions?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. @return nil


[View source]
def post_tax_registrations_id(*, id : String | Nil = nil, active_from : Stripe::PostTaxRegistrationsIdRequestActiveFrom | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostTaxRegistrationsIdRequestExpiresAt | Nil = nil) : Stripe::TaxRegistration #

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.

@required @param id [String?] @optional @param active_from [Stripe::PostTaxRegistrationsIdRequestActiveFrom?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostTaxRegistrationsIdRequestExpiresAt?] @return [Stripe::TaxRegistration]

[View source]
def post_tax_registrations_id(*, id : String | Nil = nil, active_from : Stripe::PostTaxRegistrationsIdRequestActiveFrom | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostTaxRegistrationsIdRequestExpiresAt | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates an existing Tax <code>Registration</code> object.</p> <p>A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting <code>expires_at</code>.</p> @required @param id [String?] @optional @param active_from [Stripe::PostTaxRegistrationsIdRequestActiveFrom?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostTaxRegistrationsIdRequestExpiresAt?] @return nil


[View source]
def post_tax_registrations_id_with_http_info(*, id : String | Nil = nil, active_from : Stripe::PostTaxRegistrationsIdRequestActiveFrom | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostTaxRegistrationsIdRequestExpiresAt | Nil = nil) : Tuple(Stripe::TaxRegistration, Int32, Hash(String, Array(String) | String)) #

<p>Updates an existing Tax <code>Registration</code> object.</p> <p>A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting <code>expires_at</code>.</p> @required @param id [String?] @optional @param active_from [Stripe::PostTaxRegistrationsIdRequestActiveFrom?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostTaxRegistrationsIdRequestExpiresAt?] @return [Tuple(Stripe::TaxRegistration, Integer, Hash)] Stripe::TaxRegistration, response status code and response headers


[View source]
def post_tax_registrations_with_http_info(*, active_from : Stripe::PostTaxRegistrationsRequestActiveFrom | Nil = nil, country : String | Nil = nil, country_options : Stripe::CountryOptions | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Tuple(Stripe::TaxRegistration, Int32, Hash(String, Array(String) | String)) #

<p>Creates a new Tax <code>Registration</code> object.</p> @required @param active_from [Stripe::PostTaxRegistrationsRequestActiveFrom?] @required @param country [String?] Two-letter country code (ISO 3166-1 alpha-2). @required @param country_options [Stripe::CountryOptions?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. @return [Tuple(Stripe::TaxRegistration, Integer, Hash)] Stripe::TaxRegistration, response status code and response headers


[View source]
def post_tax_settings(*, defaults : Stripe::DefaultsParam | Nil = nil, expand : Array(String) | Nil = nil, head_office : Stripe::HeadOfficeParam | Nil = nil) : Stripe::TaxSettings #

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

@optional @param defaults [Stripe::DefaultsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param head_office [Stripe::HeadOfficeParam?] @return [Stripe::TaxSettings]

[View source]
def post_tax_settings(*, defaults : Stripe::DefaultsParam | Nil = nil, expand : Array(String) | Nil = nil, head_office : Stripe::HeadOfficeParam | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates Tax <code>Settings</code> parameters used in tax calculations. All parameters are editable but none can be removed once set.</p> @optional @param defaults [Stripe::DefaultsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param head_office [Stripe::HeadOfficeParam?] @return nil


[View source]
def post_tax_settings_with_http_info(*, defaults : Stripe::DefaultsParam | Nil = nil, expand : Array(String) | Nil = nil, head_office : Stripe::HeadOfficeParam | Nil = nil) : Tuple(Stripe::TaxSettings, Int32, Hash(String, Array(String) | String)) #

<p>Updates Tax <code>Settings</code> parameters used in tax calculations. All parameters are editable but none can be removed once set.</p> @optional @param defaults [Stripe::DefaultsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param head_office [Stripe::HeadOfficeParam?] @return [Tuple(Stripe::TaxSettings, Integer, Hash)] Stripe::TaxSettings, response status code and response headers


[View source]
def post_tax_transactions_create_from_calculation(*, calculation : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, posted_at : Int64 | Nil = nil) : Stripe::TaxTransaction #

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

@required @param calculation [String?] Tax Calculation ID to be used as input when creating the transaction. @required @param reference [String?] A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param posted_at [Int32?] The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time. @return [Stripe::TaxTransaction]

[View source]
def post_tax_transactions_create_from_calculation(*, calculation : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, posted_at : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.</p> @required @param calculation [String?] Tax Calculation ID to be used as input when creating the transaction. @required @param reference [String?] A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param posted_at [Int32?] The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the tax_date and the current time, unless the tax_date is scheduled in advance. Defaults to the current time. @return nil


[View source]
def post_tax_transactions_create_from_calculation_with_http_info(*, calculation : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, posted_at : Int64 | Nil = nil) : Tuple(Stripe::TaxTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.</p> @required @param calculation [String?] Tax Calculation ID to be used as input when creating the transaction. @required @param reference [String?] A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param posted_at [Int32?] The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the tax_date and the current time, unless the tax_date is scheduled in advance. Defaults to the current time. @return [Tuple(Stripe::TaxTransaction, Integer, Hash)] Stripe::TaxTransaction, response status code and response headers


[View source]
def post_tax_transactions_create_reversal(*, mode : String | Nil = nil, original_transaction : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, flat_amount : Int64 | Nil = nil, line_items : Array(Stripe::TransactionLineItemReversal) | Nil = nil, metadata : Hash(String, String) | Nil = nil, shipping_cost : Stripe::TransactionShippingCostReversal | Nil = nil) : Stripe::TaxTransaction #

Partially or fully reverses a previously created Transaction.

@required @param mode [String?] If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed. @required @param original_transaction [String?] The ID of the Transaction to partially or fully reverse. @required @param reference [String?] A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param flat_amount [Int32?] A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. @optional @param line_items [Array(Stripe::TransactionLineItemReversal)?] The line item amounts to reverse. @optional @param metadata [Hash(String, String)?] @optional @param shipping_cost [Stripe::TransactionShippingCostReversal?] @return [Stripe::TaxTransaction]

[View source]
def post_tax_transactions_create_reversal(*, mode : String | Nil = nil, original_transaction : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, flat_amount : Int64 | Nil = nil, line_items : Array(Stripe::TransactionLineItemReversal) | Nil = nil, metadata : Hash(String, String) | Nil = nil, shipping_cost : Stripe::TransactionShippingCostReversal | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Partially or fully reverses a previously created <code>Transaction</code>.</p> @required @param mode [String?] If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed. @required @param original_transaction [String?] The ID of the Transaction to partially or fully reverse. @required @param reference [String?] A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param flat_amount [Int32?] A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes. @optional @param line_items [Array(Stripe::TransactionLineItemReversal)?] The line item amounts to reverse. @optional @param metadata [Hash(String, String)?] @optional @param shipping_cost [Stripe::TransactionShippingCostReversal?] @return nil


[View source]
def post_tax_transactions_create_reversal_with_http_info(*, mode : String | Nil = nil, original_transaction : String | Nil = nil, reference : String | Nil = nil, expand : Array(String) | Nil = nil, flat_amount : Int64 | Nil = nil, line_items : Array(Stripe::TransactionLineItemReversal) | Nil = nil, metadata : Hash(String, String) | Nil = nil, shipping_cost : Stripe::TransactionShippingCostReversal | Nil = nil) : Tuple(Stripe::TaxTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Partially or fully reverses a previously created <code>Transaction</code>.</p> @required @param mode [String?] If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed. @required @param original_transaction [String?] The ID of the Transaction to partially or fully reverse. @required @param reference [String?] A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param flat_amount [Int32?] A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes. @optional @param line_items [Array(Stripe::TransactionLineItemReversal)?] The line item amounts to reverse. @optional @param metadata [Hash(String, String)?] @optional @param shipping_cost [Stripe::TransactionShippingCostReversal?] @return [Tuple(Stripe::TaxTransaction, Integer, Hash)] Stripe::TaxTransaction, response status code and response headers


[View source]