Stripe::TaxApi
Constants
Constructors
Instance methods
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
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]<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
<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
Returns a list of Tax Registration objects.
<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
Returns a Tax Registration object.
<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
<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
<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
Retrieves Tax Settings for a merchant.
<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
<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
Retrieves a Tax Transaction object.
<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
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]<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
<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
<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
Calculates tax based on the input and returns a Tax Calculation object.
<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
<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
Creates a new Tax Registration object.
<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
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.
<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
<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
<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
Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
<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
<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
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]<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
<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
Partially or fully reverses a previously created Transaction.
<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
<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