Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostSkus

Contains the different functions to run the operation postSkus

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourcePostSkus.hs

valuepostSkus

:: MonadHTTP m
=> PostSkusRequestBody
The request body to send
-> ClientT m (Response PostSkusResponse)
Monadic computation which returns the result of the operation

POST /v1/skus

<p>Creates a new SKU associated with a product.</p>

datadata PostSkusRequestBody

Defines the object schema located at paths./v1/skus.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostSkusRequestBody
- postSkusRequestBodyActive :: Maybe Bool
  active: Whether the SKU is available for purchase. Default to `true`.
- postSkusRequestBodyAttributes :: Maybe Object
  attributes: A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`.
- postSkusRequestBodyCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- postSkusRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postSkusRequestBodyId :: Maybe Text
  id: The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.
- postSkusRequestBodyImage :: Maybe Text
  image: The URL of an image for this SKU, meant to be displayable to the customer.
  Constraints:
  - Maximum length of 5000
- postSkusRequestBodyInventory :: PostSkusRequestBodyInventory'
  inventory: Description of the SKU's inventory.
- postSkusRequestBodyMetadata :: Maybe Object
  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- postSkusRequestBodyPackageDimensions :: Maybe PostSkusRequestBodyPackageDimensions'
  package_dimensions: The dimensions of this SKU for shipping purposes.
- postSkusRequestBodyPrice :: Int
  price: The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
- postSkusRequestBodyProduct :: Text
  product: The ID of the product this SKU is associated with. Must be a product with type `good`.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSkusRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
FromJSON PostSkusRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
ToJSON PostSkusRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus

valuemkPostSkusRequestBody

:: Text
postSkusRequestBodyCurrency
-> PostSkusRequestBodyInventory'
postSkusRequestBodyInventory
-> Int
postSkusRequestBodyPrice
-> Text
postSkusRequestBodyProduct
-> PostSkusRequestBody

Create a new PostSkusRequestBody with all required fields.

datadata PostSkusRequestBodyInventory'

Defines the object schema located at paths./v1/skus.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.inventory in the specification.

Description of the SKU's inventory.

Constructors

PostSkusRequestBodyInventory'
- postSkusRequestBodyInventory'Quantity :: Maybe Int
  quantity
- postSkusRequestBodyInventory'Type :: PostSkusRequestBodyInventory'Type'
  type
- postSkusRequestBodyInventory'Value :: Maybe PostSkusRequestBodyInventory'Value'
  value

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSkusRequestBodyInventory'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusRequestBodyInventory'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
FromJSON PostSkusRequestBodyInventory'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
ToJSON PostSkusRequestBodyInventory'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus

valuemkPostSkusRequestBodyInventory'

:: PostSkusRequestBodyInventory'Type'
postSkusRequestBodyInventory'Type
-> PostSkusRequestBodyInventory'

Create a new PostSkusRequestBodyInventory' with all required fields.

datadata PostSkusRequestBodyInventory'Type'

Defines the enum schema located at paths./v1/skus.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.inventory.properties.type in the specification.

Constructors

PostSkusRequestBodyInventory'Type'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSkusRequestBodyInventory'Type'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostSkusRequestBodyInventory'Type'EnumBucket
Represents the JSON value "bucket"
PostSkusRequestBodyInventory'Type'EnumFinite
Represents the JSON value "finite"
PostSkusRequestBodyInventory'Type'EnumInfinite
Represents the JSON value "infinite"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSkusRequestBodyInventory'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusRequestBodyInventory'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
FromJSON PostSkusRequestBodyInventory'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
ToJSON PostSkusRequestBodyInventory'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus

datadata PostSkusRequestBodyInventory'Value'

Defines the enum schema located at paths./v1/skus.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.inventory.properties.value in the specification.

Constructors

PostSkusRequestBodyInventory'Value'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostSkusRequestBodyInventory'Value'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostSkusRequestBodyInventory'Value'EnumEmptyString
Represents the JSON value ""
PostSkusRequestBodyInventory'Value'EnumInStock
Represents the JSON value "in_stock"
PostSkusRequestBodyInventory'Value'EnumLimited
Represents the JSON value "limited"
PostSkusRequestBodyInventory'Value'EnumOutOfStock
Represents the JSON value "out_of_stock"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSkusRequestBodyInventory'Value'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusRequestBodyInventory'Value'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
FromJSON PostSkusRequestBodyInventory'Value'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
ToJSON PostSkusRequestBodyInventory'Value'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus

datadata PostSkusRequestBodyPackageDimensions'

Defines the object schema located at paths./v1/skus.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.package_dimensions in the specification.

The dimensions of this SKU for shipping purposes.

Constructors

PostSkusRequestBodyPackageDimensions'
- postSkusRequestBodyPackageDimensions'Height :: Double
  height
- postSkusRequestBodyPackageDimensions'Length :: Double
  length
- postSkusRequestBodyPackageDimensions'Weight :: Double
  weight
- postSkusRequestBodyPackageDimensions'Width :: Double
  width

Instances4Eq, Show, FromJSON, ToJSON

Eq PostSkusRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
FromJSON PostSkusRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
ToJSON PostSkusRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus

valuemkPostSkusRequestBodyPackageDimensions'

:: Double
postSkusRequestBodyPackageDimensions'Height
-> Double
postSkusRequestBodyPackageDimensions'Length
-> Double
postSkusRequestBodyPackageDimensions'Weight
-> Double
postSkusRequestBodyPackageDimensions'Width
-> PostSkusRequestBodyPackageDimensions'

Create a new PostSkusRequestBodyPackageDimensions' with all required fields.

datadata PostSkusResponse

Represents a response of the operation postSkus.

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

Constructors

PostSkusResponseError String
Means either no matching case available or a parse error
PostSkusResponse200 Sku
Successful response.
PostSkusResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostSkusResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus
Show PostSkusResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostSkus