Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPricesPrice

Description

Contains the different functions to run the operation postPricesPrice

Synopsis

postPricesPrice :: forall m. MonadHTTP m => Text -> Maybe PostPricesPriceRequestBody -> ClientT m (Response PostPricesPriceResponse)
data PostPricesPriceRequestBody = PostPricesPriceRequestBody {
}
mkPostPricesPriceRequestBody :: PostPricesPriceRequestBody
data PostPricesPriceRequestBodyMetadata'Variants
- = PostPricesPriceRequestBodyMetadata'EmptyString
- | PostPricesPriceRequestBodyMetadata'Object Object
data PostPricesPriceRequestBodyTaxBehavior'
data PostPricesPriceResponse

Documentation

postPricesPrice Source #

Arguments

:: forall m. MonadHTTP m
=> Text	price \| Constraints: Maximum length of 5000
-> Maybe PostPricesPriceRequestBody	The request body to send
-> ClientT m (Response PostPricesPriceResponse)	Monadic computation which returns the result of the operation

POST /v1/prices/{price}

<p>Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p>

data PostPricesPriceRequestBody Source #

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

Constructors

PostPricesPriceRequestBody

Fields

postPricesPriceRequestBodyActive :: Maybe Bool
active: Whether the price can be used for new purchases. Defaults to `true`.
postPricesPriceRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postPricesPriceRequestBodyLookupKey :: Maybe Text
lookup_key: A lookup key used to retrieve prices dynamically from a static string.
Constraints:
- Maximum length of 5000
postPricesPriceRequestBodyMetadata :: Maybe PostPricesPriceRequestBodyMetadata'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`.
postPricesPriceRequestBodyNickname :: Maybe Text
nickname: A brief description of the price, hidden from customers.
Constraints:
- Maximum length of 5000
postPricesPriceRequestBodyTaxBehavior :: Maybe PostPricesPriceRequestBodyTaxBehavior'
tax_behavior: Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
postPricesPriceRequestBodyTransferLookupKey :: Maybe Bool
transfer_lookup_key: If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

Instances

Instances details

Eq PostPricesPriceRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods (==) :: PostPricesPriceRequestBody -> PostPricesPriceRequestBody -> Bool # (/=) :: PostPricesPriceRequestBody -> PostPricesPriceRequestBody -> Bool #
Show PostPricesPriceRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods showsPrec :: Int -> PostPricesPriceRequestBody -> ShowS # show :: PostPricesPriceRequestBody -> String # showList :: [PostPricesPriceRequestBody] -> ShowS #
ToJSON PostPricesPriceRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods toJSON :: PostPricesPriceRequestBody -> Value # toEncoding :: PostPricesPriceRequestBody -> Encoding # toJSONList :: [PostPricesPriceRequestBody] -> Value # toEncodingList :: [PostPricesPriceRequestBody] -> Encoding #
FromJSON PostPricesPriceRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods parseJSON :: Value -> Parser PostPricesPriceRequestBody # parseJSONList :: Value -> Parser [PostPricesPriceRequestBody] #

mkPostPricesPriceRequestBody :: PostPricesPriceRequestBody Source #

Create a new PostPricesPriceRequestBody with all required fields.

data PostPricesPriceRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/prices/{price}.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

PostPricesPriceRequestBodyMetadata'EmptyString	Represents the JSON value `""`
PostPricesPriceRequestBodyMetadata'Object Object

Instances

Instances details

Eq PostPricesPriceRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods (==) :: PostPricesPriceRequestBodyMetadata'Variants -> PostPricesPriceRequestBodyMetadata'Variants -> Bool # (/=) :: PostPricesPriceRequestBodyMetadata'Variants -> PostPricesPriceRequestBodyMetadata'Variants -> Bool #
Show PostPricesPriceRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods showsPrec :: Int -> PostPricesPriceRequestBodyMetadata'Variants -> ShowS # show :: PostPricesPriceRequestBodyMetadata'Variants -> String # showList :: [PostPricesPriceRequestBodyMetadata'Variants] -> ShowS #
ToJSON PostPricesPriceRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods toJSON :: PostPricesPriceRequestBodyMetadata'Variants -> Value # toEncoding :: PostPricesPriceRequestBodyMetadata'Variants -> Encoding # toJSONList :: [PostPricesPriceRequestBodyMetadata'Variants] -> Value # toEncodingList :: [PostPricesPriceRequestBodyMetadata'Variants] -> Encoding #
FromJSON PostPricesPriceRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods parseJSON :: Value -> Parser PostPricesPriceRequestBodyMetadata'Variants # parseJSONList :: Value -> Parser [PostPricesPriceRequestBodyMetadata'Variants] #

data PostPricesPriceRequestBodyTaxBehavior' Source #

Defines the enum schema located at paths./v1/prices/{price}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax_behavior in the specification.

Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.

Constructors

PostPricesPriceRequestBodyTaxBehavior'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostPricesPriceRequestBodyTaxBehavior'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostPricesPriceRequestBodyTaxBehavior'EnumExclusive	Represents the JSON value `"exclusive"`
PostPricesPriceRequestBodyTaxBehavior'EnumInclusive	Represents the JSON value `"inclusive"`
PostPricesPriceRequestBodyTaxBehavior'EnumUnspecified	Represents the JSON value `"unspecified"`

Instances

Instances details

Eq PostPricesPriceRequestBodyTaxBehavior' Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods (==) :: PostPricesPriceRequestBodyTaxBehavior' -> PostPricesPriceRequestBodyTaxBehavior' -> Bool # (/=) :: PostPricesPriceRequestBodyTaxBehavior' -> PostPricesPriceRequestBodyTaxBehavior' -> Bool #
Show PostPricesPriceRequestBodyTaxBehavior' Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods showsPrec :: Int -> PostPricesPriceRequestBodyTaxBehavior' -> ShowS # show :: PostPricesPriceRequestBodyTaxBehavior' -> String # showList :: [PostPricesPriceRequestBodyTaxBehavior'] -> ShowS #
ToJSON PostPricesPriceRequestBodyTaxBehavior' Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods toJSON :: PostPricesPriceRequestBodyTaxBehavior' -> Value # toEncoding :: PostPricesPriceRequestBodyTaxBehavior' -> Encoding # toJSONList :: [PostPricesPriceRequestBodyTaxBehavior'] -> Value # toEncodingList :: [PostPricesPriceRequestBodyTaxBehavior'] -> Encoding #
FromJSON PostPricesPriceRequestBodyTaxBehavior' Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods parseJSON :: Value -> Parser PostPricesPriceRequestBodyTaxBehavior' # parseJSONList :: Value -> Parser [PostPricesPriceRequestBodyTaxBehavior'] #

data PostPricesPriceResponse Source #

Represents a response of the operation postPricesPrice.

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

Constructors

PostPricesPriceResponseError String	Means either no matching case available or a parse error
PostPricesPriceResponse200 Price	Successful response.
PostPricesPriceResponseDefault Error	Error response.

Instances

Instances details

Eq PostPricesPriceResponse Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods (==) :: PostPricesPriceResponse -> PostPricesPriceResponse -> Bool # (/=) :: PostPricesPriceResponse -> PostPricesPriceResponse -> Bool #
Show PostPricesPriceResponse Source #
Instance details Defined in StripeAPI.Operations.PostPricesPrice Methods showsPrec :: Int -> PostPricesPriceResponse -> ShowS # show :: PostPricesPriceResponse -> String # showList :: [PostPricesPriceResponse] -> ShowS #