class Stripe::TaxRatesApi
- Stripe::TaxRatesApi
- Reference
- Object
Defined in:
stripe/api/tax_rates_api.crConstant Summary
-
GET_TAX_RATES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_TAX_RATES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_TAX_RATE =
5000 -
POST_TAX_RATES_MAX_LENGTH_FOR_COUNTRY =
5000 -
POST_TAX_RATES_MAX_LENGTH_FOR_DESCRIPTION =
5000 -
POST_TAX_RATES_MAX_LENGTH_FOR_DISPLAY_NAME =
50 -
POST_TAX_RATES_MAX_LENGTH_FOR_JURISDICTION =
50 -
POST_TAX_RATES_MAX_LENGTH_FOR_STATE =
2 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_COUNTRY =
5000 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_DESCRIPTION =
5000 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_DISPLAY_NAME =
50 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_JURISDICTION =
50 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_STATE =
2 -
POST_TAX_RATES_TAX_RATE_MAX_LENGTH_FOR_TAX_RATE =
5000 -
POST_TAX_RATES_TAX_RATE_VALID_VALUES_FOR_TAX_TYPE =
String.static_array("amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat") -
POST_TAX_RATES_VALID_VALUES_FOR_TAX_TYPE =
String.static_array("amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_tax_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, inclusive : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_tax_rates(*, display_name : String | Nil = nil, inclusive : Bool | Nil = nil, percentage : Float64 | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_tax_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, inclusive : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxRatesList
Returns a list of your tax rates.
-
#get_tax_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, inclusive : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of your tax rates.
-
#get_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxRate
Retrieves a tax rate with the given ID
@required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a tax rate with the given ID</p> @required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_tax_rates_tax_rate_with_http_info(*, tax_rate : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxRate, Int32, Hash(String, Array(String) | String))
<p>Retrieves a tax rate with the given ID</p> @required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_tax_rates_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, active : Bool | Nil = nil, inclusive : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxRatesList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of your tax rates.
-
#post_tax_rates(*, display_name : String | Nil = nil, inclusive : Bool | Nil = nil, percentage : Float64 | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Stripe::TaxRate
Creates a new tax rate.
@required @param display_name [String?] The display name of the tax rate, which will be shown to users. -
#post_tax_rates(*, display_name : String | Nil = nil, inclusive : Bool | Nil = nil, percentage : Float64 | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new tax rate.</p> @required @param display_name [String?] The display name of the tax rate, which will be shown to users.
-
#post_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Stripe::TaxRate
Updates an existing tax rate.
@required @param tax_rate [String?] @optional @param active [Bool?] Flag determining whether the tax rate is active or inactive (archived). -
#post_tax_rates_tax_rate(*, tax_rate : String | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing tax rate.</p> @required @param tax_rate [String?] @optional @param active [Bool?] Flag determining whether the tax rate is active or inactive (archived).
-
#post_tax_rates_tax_rate_with_http_info(*, tax_rate : String | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Tuple(Stripe::TaxRate, Int32, Hash(String, Array(String) | String))
<p>Updates an existing tax rate.</p> @required @param tax_rate [String?] @optional @param active [Bool?] Flag determining whether the tax rate is active or inactive (archived).
-
#post_tax_rates_with_http_info(*, display_name : String | Nil = nil, inclusive : Bool | Nil = nil, percentage : Float64 | Nil = nil, active : Bool | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, jurisdiction : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, state : String | Nil = nil, tax_type : String | Nil = nil) : Tuple(Stripe::TaxRate, Int32, Hash(String, Array(String) | String))
<p>Creates a new tax rate.</p> @required @param display_name [String?] The display name of the tax rate, which will be shown to users.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
@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 active [Bool?] Optional flag to filter by tax rates that are either active or inactive (archived). @optional @param inclusive [Bool?] Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). @optional @param created [Stripe::GetAccountsCreatedParameter?] Optional range for filtering created date. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxRatesList]<p>Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.</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 active [Bool?] Optional flag to filter by tax rates that are either active or inactive (archived).
@optional @param inclusive [Bool?] Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
@optional @param created [Stripe::GetAccountsCreatedParameter?] Optional range for filtering created date.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a tax rate with the given ID
@required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxRate]<p>Retrieves a tax rate with the given ID</p> @required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a tax rate with the given ID</p> @required @param tax_rate [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxRate, Integer, Hash)] Stripe::TaxRate, response status code and response headers
<p>Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.</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 active [Bool?] Optional flag to filter by tax rates that are either active or inactive (archived).
@optional @param inclusive [Bool?] Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
@optional @param created [Stripe::GetAccountsCreatedParameter?] Optional range for filtering created date.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::TaxRatesList, Integer, Hash)] Stripe::TaxRatesList, response status code and response headers
Creates a new tax rate.
@required @param display_name [String?] The display name of the tax rate, which will be shown to users. @required @param inclusive [Bool?] This specifies if the tax rate is inclusive or exclusive. @required @param percentage [Float64?] This represents the tax rate percent out of 100. @optional @param active [Bool?] 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. @optional @param country [String?] Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). @optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. @optional @param metadata [Hash(String, String)?] @optional @param state [String?] [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \\\"NY\\\" for New York, United States. @optional @param tax_type [String?] The high-level tax type, such as `vat` or `sales_tax`. @return [Stripe::TaxRate]<p>Creates a new tax rate.</p>
@required @param display_name [String?] The display name of the tax rate, which will be shown to users.
@required @param inclusive [Bool?] This specifies if the tax rate is inclusive or exclusive.
@required @param percentage [Float64?] This represents the tax rate percent out of 100.
@optional @param active [Bool?] 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.
@optional @param country [String?] Two-letter country code (ISO 3166-1 alpha-2).
@optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
@optional @param metadata [Hash(String, String)?]
@optional @param state [String?] ISO 3166-2 subdivision code, without country prefix. For example, \"NY\" for New York, United States.
@optional @param tax_type [String?] The high-level tax type, such as vat or sales_tax.
@return nil
Updates an existing tax rate.
@required @param tax_rate [String?] @optional @param active [Bool?] 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. @optional @param country [String?] Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). @optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. @optional @param display_name [String?] The display name of the tax rate, which will be shown to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param state [String?] [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \\\"NY\\\" for New York, United States. @optional @param tax_type [String?] The high-level tax type, such as `vat` or `sales_tax`. @return [Stripe::TaxRate]<p>Updates an existing tax rate.</p>
@required @param tax_rate [String?]
@optional @param active [Bool?] 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.
@optional @param country [String?] Two-letter country code (ISO 3166-1 alpha-2).
@optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
@optional @param display_name [String?] The display name of the tax rate, which will be shown to users.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param state [String?] ISO 3166-2 subdivision code, without country prefix. For example, \"NY\" for New York, United States.
@optional @param tax_type [String?] The high-level tax type, such as vat or sales_tax.
@return nil
<p>Updates an existing tax rate.</p>
@required @param tax_rate [String?]
@optional @param active [Bool?] 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.
@optional @param country [String?] Two-letter country code (ISO 3166-1 alpha-2).
@optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
@optional @param display_name [String?] The display name of the tax rate, which will be shown to users.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param state [String?] ISO 3166-2 subdivision code, without country prefix. For example, \"NY\" for New York, United States.
@optional @param tax_type [String?] The high-level tax type, such as vat or sales_tax.
@return [Tuple(Stripe::TaxRate, Integer, Hash)] Stripe::TaxRate, response status code and response headers
<p>Creates a new tax rate.</p>
@required @param display_name [String?] The display name of the tax rate, which will be shown to users.
@required @param inclusive [Bool?] This specifies if the tax rate is inclusive or exclusive.
@required @param percentage [Float64?] This represents the tax rate percent out of 100.
@optional @param active [Bool?] 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.
@optional @param country [String?] Two-letter country code (ISO 3166-1 alpha-2).
@optional @param description [String?] An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param jurisdiction [String?] The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
@optional @param metadata [Hash(String, String)?]
@optional @param state [String?] ISO 3166-2 subdivision code, without country prefix. For example, \"NY\" for New York, United States.
@optional @param tax_type [String?] The high-level tax type, such as vat or sales_tax.
@return [Tuple(Stripe::TaxRate, Integer, Hash)] Stripe::TaxRate, response status code and response headers