stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetSkus

Description

Contains the different functions to run the operation getSkus

Synopsis

Documentation

getSkus Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe Bool

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

-> Maybe String

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`.

-> Maybe String

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

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe String

ids: Only return SKUs with the given IDs.

-> Maybe Bool

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.

-> Maybe Integer

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

-> Maybe String

product: The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. | Constraints: Maximum length of 5000

-> Maybe String

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

-> GetSkusRequestBody

The request body to send

-> m (Either HttpException (Response GetSkusResponse))

Monad containing 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 GetSkusResponse Source #

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.

data GetSkusResponseBody200 Source #

Defines the data type for the schema GetSkusResponseBody200

Constructors

GetSkusResponseBody200 

Fields