StripeAPI.Operations.GetTaxCodes

Contains the different functions to run the operation getTaxCodes

Documentation

getTaxCodes

Arguments

:: forall m. MonadHTTP m

=> GetTaxCodesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetTaxCodesResponse)

Monadic computation which returns the result of the operation

GET /v1/tax_codes

<p>A list of <a href="https://stripe.com/docs/tax/tax-codes">all tax codes available</a> to add to Products in order to allow specific tax calculations.</p>

data GetTaxCodesParameters

Defines the object schema located at paths./v1/tax_codes.GET.parameters in the specification.

Constructors

GetTaxCodesParameters

Fields

• getTaxCodesParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named 'ending_before'

  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.

• getTaxCodesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getTaxCodesParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• getTaxCodesParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named 'starting_after'

  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.

Instances

Eq GetTaxCodesParameters

Defined in StripeAPI.Operations.GetTaxCodes

Methods

(==) :: GetTaxCodesParameters -> GetTaxCodesParameters -> Bool

(/=) :: GetTaxCodesParameters -> GetTaxCodesParameters -> Bool

Show GetTaxCodesParameters

Defined in StripeAPI.Operations.GetTaxCodes

Methods

showsPrec :: Int -> GetTaxCodesParameters -> ShowS

show :: GetTaxCodesParameters -> String

showList :: [GetTaxCodesParameters] -> ShowS

ToJSON GetTaxCodesParameters

Defined in StripeAPI.Operations.GetTaxCodes

Methods

toJSON :: GetTaxCodesParameters -> Value

toEncoding :: GetTaxCodesParameters -> Encoding

toJSONList :: [GetTaxCodesParameters] -> Value

toEncodingList :: [GetTaxCodesParameters] -> Encoding

FromJSON GetTaxCodesParameters

Defined in StripeAPI.Operations.GetTaxCodes

Methods

parseJSON :: Value -> Parser GetTaxCodesParameters

parseJSONList :: Value -> Parser [GetTaxCodesParameters]

mkGetTaxCodesParameters :: GetTaxCodesParameters

Create a new GetTaxCodesParameters with all required fields.

data GetTaxCodesResponse

Represents a response of the operation getTaxCodes.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetTaxCodesResponseError is used.

Constructors

GetTaxCodesResponseError String

Means either no matching case available or a parse error

GetTaxCodesResponse200 GetTaxCodesResponseBody200

Successful response.

GetTaxCodesResponseDefault Error

Error response.

Instances

Eq GetTaxCodesResponse

Defined in StripeAPI.Operations.GetTaxCodes

Methods

(==) :: GetTaxCodesResponse -> GetTaxCodesResponse -> Bool

(/=) :: GetTaxCodesResponse -> GetTaxCodesResponse -> Bool

Show GetTaxCodesResponse

Defined in StripeAPI.Operations.GetTaxCodes

Methods

showsPrec :: Int -> GetTaxCodesResponse -> ShowS

show :: GetTaxCodesResponse -> String

showList :: [GetTaxCodesResponse] -> ShowS

data GetTaxCodesResponseBody200

Defines the object schema located at paths./v1/tax_codes.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetTaxCodesResponseBody200

Fields

• getTaxCodesResponseBody200Data :: [TaxCode]

  data

• getTaxCodesResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getTaxCodesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetTaxCodesResponseBody200

Defined in StripeAPI.Operations.GetTaxCodes

Methods

(==) :: GetTaxCodesResponseBody200 -> GetTaxCodesResponseBody200 -> Bool

(/=) :: GetTaxCodesResponseBody200 -> GetTaxCodesResponseBody200 -> Bool

Show GetTaxCodesResponseBody200

Defined in StripeAPI.Operations.GetTaxCodes

Methods

showsPrec :: Int -> GetTaxCodesResponseBody200 -> ShowS

show :: GetTaxCodesResponseBody200 -> String

showList :: [GetTaxCodesResponseBody200] -> ShowS

ToJSON GetTaxCodesResponseBody200

Defined in StripeAPI.Operations.GetTaxCodes

Methods

toJSON :: GetTaxCodesResponseBody200 -> Value

toEncoding :: GetTaxCodesResponseBody200 -> Encoding

toJSONList :: [GetTaxCodesResponseBody200] -> Value

toEncodingList :: [GetTaxCodesResponseBody200] -> Encoding

FromJSON GetTaxCodesResponseBody200

Defined in StripeAPI.Operations.GetTaxCodes

Methods

parseJSON :: Value -> Parser GetTaxCodesResponseBody200

parseJSONList :: Value -> Parser [GetTaxCodesResponseBody200]

mkGetTaxCodesResponseBody200

Arguments

:: [TaxCode]

getTaxCodesResponseBody200Data

-> Bool

getTaxCodesResponseBody200HasMore

-> Text

getTaxCodesResponseBody200Url

-> GetTaxCodesResponseBody200

Create a new GetTaxCodesResponseBody200 with all required fields.