StripeAPI.Operations.PostSkusId

Contains the different functions to run the operation postSkusId

Documentation

postSkusId

Arguments

:: forall m. MonadHTTP m

=> Text

id | Constraints: Maximum length of 5000

-> Maybe PostSkusIdRequestBody

The request body to send

-> StripeT m (Response PostSkusIdResponse)

Monadic computation which returns the result of the operation

POST /v1/skus/{id}

<p>Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

<p>Note that a SKU’s <code>attributes</code> are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.</p>

data PostSkusIdRequestBody

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

Constructors

PostSkusIdRequestBody

Fields

• postSkusIdRequestBodyActive :: Maybe Bool

  active: Whether this SKU is available for purchase.

• postSkusIdRequestBodyAttributes :: Maybe Object

  attributes: A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product.

• postSkusIdRequestBodyCurrency :: Maybe Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• postSkusIdRequestBodyExpand :: Maybe [Text]

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

• postSkusIdRequestBodyImage :: Maybe Text

  image: The URL of an image for this SKU, meant to be displayable to the customer.

  Constraints:

  • Maximum length of 5000
• postSkusIdRequestBodyInventory :: Maybe PostSkusIdRequestBodyInventory'

  inventory: Description of the SKU's inventory.

• postSkusIdRequestBodyMetadata :: Maybe PostSkusIdRequestBodyMetadata'Variants

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

• postSkusIdRequestBodyPackageDimensions :: Maybe PostSkusIdRequestBodyPackageDimensions'Variants

  package_dimensions: The dimensions of this SKU for shipping purposes.

• postSkusIdRequestBodyPrice :: Maybe Int

  price: The cost of the item as a positive 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).

• postSkusIdRequestBodyProduct :: Maybe Text

  product: The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`.

  Constraints:

  • Maximum length of 5000

Instances

Eq PostSkusIdRequestBody

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBody -> PostSkusIdRequestBody -> Bool

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

Show PostSkusIdRequestBody

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBody -> ShowS

show :: PostSkusIdRequestBody -> String

showList :: [PostSkusIdRequestBody] -> ShowS

ToJSON PostSkusIdRequestBody

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBody -> Value

toEncoding :: PostSkusIdRequestBody -> Encoding

toJSONList :: [PostSkusIdRequestBody] -> Value

toEncodingList :: [PostSkusIdRequestBody] -> Encoding

FromJSON PostSkusIdRequestBody

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBody

parseJSONList :: Value -> Parser [PostSkusIdRequestBody]

mkPostSkusIdRequestBody :: PostSkusIdRequestBody

Create a new PostSkusIdRequestBody with all required fields.

data PostSkusIdRequestBodyInventory'

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

Description of the SKU's inventory.

Constructors

PostSkusIdRequestBodyInventory'

Fields

• postSkusIdRequestBodyInventory'Quantity :: Maybe Int

  quantity

• postSkusIdRequestBodyInventory'Type :: Maybe PostSkusIdRequestBodyInventory'Type'

  type

• postSkusIdRequestBodyInventory'Value :: Maybe PostSkusIdRequestBodyInventory'Value'

  value

Instances

Eq PostSkusIdRequestBodyInventory'

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyInventory' -> PostSkusIdRequestBodyInventory' -> Bool

(/=) :: PostSkusIdRequestBodyInventory' -> PostSkusIdRequestBodyInventory' -> Bool

Show PostSkusIdRequestBodyInventory'

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyInventory' -> ShowS

show :: PostSkusIdRequestBodyInventory' -> String

showList :: [PostSkusIdRequestBodyInventory'] -> ShowS

ToJSON PostSkusIdRequestBodyInventory'

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyInventory' -> Value

toEncoding :: PostSkusIdRequestBodyInventory' -> Encoding

toJSONList :: [PostSkusIdRequestBodyInventory'] -> Value

toEncodingList :: [PostSkusIdRequestBodyInventory'] -> Encoding

FromJSON PostSkusIdRequestBodyInventory'

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyInventory'

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyInventory']

mkPostSkusIdRequestBodyInventory' :: PostSkusIdRequestBodyInventory'

Create a new PostSkusIdRequestBodyInventory' with all required fields.

data PostSkusIdRequestBodyInventory'Type'

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

Constructors

PostSkusIdRequestBodyInventory'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSkusIdRequestBodyInventory'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSkusIdRequestBodyInventory'Type'EnumBucket

Represents the JSON value "bucket"

PostSkusIdRequestBodyInventory'Type'EnumFinite

Represents the JSON value "finite"

PostSkusIdRequestBodyInventory'Type'EnumInfinite

Represents the JSON value "infinite"

Instances

Eq PostSkusIdRequestBodyInventory'Type'

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyInventory'Type' -> PostSkusIdRequestBodyInventory'Type' -> Bool

(/=) :: PostSkusIdRequestBodyInventory'Type' -> PostSkusIdRequestBodyInventory'Type' -> Bool

Show PostSkusIdRequestBodyInventory'Type'

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyInventory'Type' -> ShowS

show :: PostSkusIdRequestBodyInventory'Type' -> String

showList :: [PostSkusIdRequestBodyInventory'Type'] -> ShowS

ToJSON PostSkusIdRequestBodyInventory'Type'

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyInventory'Type' -> Value

toEncoding :: PostSkusIdRequestBodyInventory'Type' -> Encoding

toJSONList :: [PostSkusIdRequestBodyInventory'Type'] -> Value

toEncodingList :: [PostSkusIdRequestBodyInventory'Type'] -> Encoding

FromJSON PostSkusIdRequestBodyInventory'Type'

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyInventory'Type'

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyInventory'Type']

data PostSkusIdRequestBodyInventory'Value'

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

Constructors

PostSkusIdRequestBodyInventory'Value'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostSkusIdRequestBodyInventory'Value'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostSkusIdRequestBodyInventory'Value'EnumEmptyString

Represents the JSON value ""

PostSkusIdRequestBodyInventory'Value'EnumInStock

Represents the JSON value "in_stock"

PostSkusIdRequestBodyInventory'Value'EnumLimited

Represents the JSON value "limited"

PostSkusIdRequestBodyInventory'Value'EnumOutOfStock

Represents the JSON value "out_of_stock"

Instances

Eq PostSkusIdRequestBodyInventory'Value'

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyInventory'Value' -> PostSkusIdRequestBodyInventory'Value' -> Bool

(/=) :: PostSkusIdRequestBodyInventory'Value' -> PostSkusIdRequestBodyInventory'Value' -> Bool

Show PostSkusIdRequestBodyInventory'Value'

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyInventory'Value' -> ShowS

show :: PostSkusIdRequestBodyInventory'Value' -> String

showList :: [PostSkusIdRequestBodyInventory'Value'] -> ShowS

ToJSON PostSkusIdRequestBodyInventory'Value'

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyInventory'Value' -> Value

toEncoding :: PostSkusIdRequestBodyInventory'Value' -> Encoding

toJSONList :: [PostSkusIdRequestBodyInventory'Value'] -> Value

toEncodingList :: [PostSkusIdRequestBodyInventory'Value'] -> Encoding

FromJSON PostSkusIdRequestBodyInventory'Value'

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyInventory'Value'

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyInventory'Value']

data PostSkusIdRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/skus/{id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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

Constructors

PostSkusIdRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostSkusIdRequestBodyMetadata'Object Object

Instances

Eq PostSkusIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyMetadata'Variants -> PostSkusIdRequestBodyMetadata'Variants -> Bool

(/=) :: PostSkusIdRequestBodyMetadata'Variants -> PostSkusIdRequestBodyMetadata'Variants -> Bool

Show PostSkusIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyMetadata'Variants -> ShowS

show :: PostSkusIdRequestBodyMetadata'Variants -> String

showList :: [PostSkusIdRequestBodyMetadata'Variants] -> ShowS

ToJSON PostSkusIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyMetadata'Variants -> Value

toEncoding :: PostSkusIdRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostSkusIdRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostSkusIdRequestBodyMetadata'Variants] -> Encoding

FromJSON PostSkusIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyMetadata'Variants]

data PostSkusIdRequestBodyPackageDimensions'OneOf1

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

Constructors

PostSkusIdRequestBodyPackageDimensions'OneOf1

Fields

• postSkusIdRequestBodyPackageDimensions'OneOf1Height :: Double

  height

• postSkusIdRequestBodyPackageDimensions'OneOf1Length :: Double

  length

• postSkusIdRequestBodyPackageDimensions'OneOf1Weight :: Double

  weight

• postSkusIdRequestBodyPackageDimensions'OneOf1Width :: Double

  width

Instances

Eq PostSkusIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyPackageDimensions'OneOf1 -> PostSkusIdRequestBodyPackageDimensions'OneOf1 -> Bool

(/=) :: PostSkusIdRequestBodyPackageDimensions'OneOf1 -> PostSkusIdRequestBodyPackageDimensions'OneOf1 -> Bool

Show PostSkusIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyPackageDimensions'OneOf1 -> ShowS

show :: PostSkusIdRequestBodyPackageDimensions'OneOf1 -> String

showList :: [PostSkusIdRequestBodyPackageDimensions'OneOf1] -> ShowS

ToJSON PostSkusIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyPackageDimensions'OneOf1 -> Value

toEncoding :: PostSkusIdRequestBodyPackageDimensions'OneOf1 -> Encoding

toJSONList :: [PostSkusIdRequestBodyPackageDimensions'OneOf1] -> Value

toEncodingList :: [PostSkusIdRequestBodyPackageDimensions'OneOf1] -> Encoding

FromJSON PostSkusIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyPackageDimensions'OneOf1

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyPackageDimensions'OneOf1]

mkPostSkusIdRequestBodyPackageDimensions'OneOf1

Arguments

:: Double

postSkusIdRequestBodyPackageDimensions'OneOf1Height

-> Double

postSkusIdRequestBodyPackageDimensions'OneOf1Length

-> Double

postSkusIdRequestBodyPackageDimensions'OneOf1Weight

-> Double

postSkusIdRequestBodyPackageDimensions'OneOf1Width

-> PostSkusIdRequestBodyPackageDimensions'OneOf1

Create a new PostSkusIdRequestBodyPackageDimensions'OneOf1 with all required fields.

data PostSkusIdRequestBodyPackageDimensions'Variants

Defines the oneOf schema located at paths./v1/skus/{id}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.package_dimensions.anyOf in the specification.

The dimensions of this SKU for shipping purposes.

Constructors

PostSkusIdRequestBodyPackageDimensions'EmptyString

Represents the JSON value ""

PostSkusIdRequestBodyPackageDimensions'PostSkusIdRequestBodyPackageDimensions'OneOf1 PostSkusIdRequestBodyPackageDimensions'OneOf1

Instances

Eq PostSkusIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdRequestBodyPackageDimensions'Variants -> PostSkusIdRequestBodyPackageDimensions'Variants -> Bool

(/=) :: PostSkusIdRequestBodyPackageDimensions'Variants -> PostSkusIdRequestBodyPackageDimensions'Variants -> Bool

Show PostSkusIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdRequestBodyPackageDimensions'Variants -> ShowS

show :: PostSkusIdRequestBodyPackageDimensions'Variants -> String

showList :: [PostSkusIdRequestBodyPackageDimensions'Variants] -> ShowS

ToJSON PostSkusIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

toJSON :: PostSkusIdRequestBodyPackageDimensions'Variants -> Value

toEncoding :: PostSkusIdRequestBodyPackageDimensions'Variants -> Encoding

toJSONList :: [PostSkusIdRequestBodyPackageDimensions'Variants] -> Value

toEncodingList :: [PostSkusIdRequestBodyPackageDimensions'Variants] -> Encoding

FromJSON PostSkusIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostSkusId

Methods

parseJSON :: Value -> Parser PostSkusIdRequestBodyPackageDimensions'Variants

parseJSONList :: Value -> Parser [PostSkusIdRequestBodyPackageDimensions'Variants]

data PostSkusIdResponse

Represents a response of the operation postSkusId.

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

Constructors

PostSkusIdResponseError String

Means either no matching case available or a parse error

PostSkusIdResponse200 Sku

Successful response.

PostSkusIdResponseDefault Error

Error response.

Instances

Eq PostSkusIdResponse

Defined in StripeAPI.Operations.PostSkusId

Methods

(==) :: PostSkusIdResponse -> PostSkusIdResponse -> Bool

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

Show PostSkusIdResponse

Defined in StripeAPI.Operations.PostSkusId

Methods

showsPrec :: Int -> PostSkusIdResponse -> ShowS

show :: PostSkusIdResponse -> String

showList :: [PostSkusIdResponse] -> ShowS