StripeAPI.Operations.GetSkus

Contains the different functions to run the operation getSkus

Documentation

getSkus

Arguments

:: forall m. MonadHTTP m

=> GetSkusParameters

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

-> StripeT m (Response GetSkusResponse)

Monadic computation which returns the result of the operation

GET /v1/skus

<p>Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.</p>

data GetSkusParameters

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

Constructors

GetSkusParameters

Fields

• getSkusParametersQueryActive :: Maybe Bool

  queryActive: Represents the parameter named 'active'

  Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products).

• getSkusParametersQueryAttributes :: Maybe Object

  queryAttributes: Represents the parameter named 'attributes'

  Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`.

• getSkusParametersQueryEndingBefore :: 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.

  Constraints:

  • Maximum length of 5000
• getSkusParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getSkusParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Only return SKUs with the given IDs.

• getSkusParametersQueryInStock :: Maybe Bool

  queryIn_stock: Represents the parameter named 'in_stock'

  Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.

• getSkusParametersQueryLimit :: 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.

• getSkusParametersQueryProduct :: Maybe Text

  queryProduct: Represents the parameter named 'product'

  The ID of the product whose SKUs will be retrieved. Must be a product with type `good`.

  Constraints:

  • Maximum length of 5000
• getSkusParametersQueryStartingAfter :: 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.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetSkusParameters

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusParameters -> GetSkusParameters -> Bool

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

Show GetSkusParameters

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusParameters -> ShowS

show :: GetSkusParameters -> String

showList :: [GetSkusParameters] -> ShowS

ToJSON GetSkusParameters

Defined in StripeAPI.Operations.GetSkus

Methods

toJSON :: GetSkusParameters -> Value

toEncoding :: GetSkusParameters -> Encoding

toJSONList :: [GetSkusParameters] -> Value

toEncodingList :: [GetSkusParameters] -> Encoding

FromJSON GetSkusParameters

Defined in StripeAPI.Operations.GetSkus

Methods

parseJSON :: Value -> Parser GetSkusParameters

parseJSONList :: Value -> Parser [GetSkusParameters]

mkGetSkusParameters :: GetSkusParameters

Create a new GetSkusParameters with all required fields.

data GetSkusResponse

Represents a response of the operation getSkus.

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), GetSkusResponseError is used.

Constructors

GetSkusResponseError String

Means either no matching case available or a parse error

GetSkusResponse200 GetSkusResponseBody200

Successful response.

GetSkusResponseDefault Error

Error response.

Instances

Eq GetSkusResponse

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusResponse -> GetSkusResponse -> Bool

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

Show GetSkusResponse

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusResponse -> ShowS

show :: GetSkusResponse -> String

showList :: [GetSkusResponse] -> ShowS

data GetSkusResponseBody200

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

Constructors

GetSkusResponseBody200

Fields

• getSkusResponseBody200Data :: [Sku]

  data

• getSkusResponseBody200HasMore :: Bool

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

• getSkusResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/skus'

Instances

Eq GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusResponseBody200 -> GetSkusResponseBody200 -> Bool

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

Show GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusResponseBody200 -> ShowS

show :: GetSkusResponseBody200 -> String

showList :: [GetSkusResponseBody200] -> ShowS

ToJSON GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

toJSON :: GetSkusResponseBody200 -> Value

toEncoding :: GetSkusResponseBody200 -> Encoding

toJSONList :: [GetSkusResponseBody200] -> Value

toEncodingList :: [GetSkusResponseBody200] -> Encoding

FromJSON GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

parseJSON :: Value -> Parser GetSkusResponseBody200

parseJSONList :: Value -> Parser [GetSkusResponseBody200]

mkGetSkusResponseBody200

Arguments

:: [Sku]

getSkusResponseBody200Data

-> Bool

getSkusResponseBody200HasMore

-> Text

getSkusResponseBody200Url

-> GetSkusResponseBody200

Create a new GetSkusResponseBody200 with all required fields.