Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPlansPlan

Description

Contains the different functions to run the operation postPlansPlan

Synopsis

postPlansPlan :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPlansPlanRequestBody -> m (Either HttpException (Response PostPlansPlanResponse))
postPlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPlansPlanRequestBody -> m (Either HttpException (Response ByteString))
postPlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPlansPlanResponse))
postPlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostPlansPlanRequestBody = PostPlansPlanRequestBody {
}
data PostPlansPlanRequestBodyMetadata' = PostPlansPlanRequestBodyMetadata' {
}
data PostPlansPlanResponse

Documentation

postPlansPlan Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	plan \| Constraints: Maximum length of 5000
-> Maybe PostPlansPlanRequestBody	The request body to send
-> m (Either HttpException (Response PostPlansPlanResponse))	Monad containing the result of the operation

POST /v1/plans/{plan}

<p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.</p>

postPlansPlanRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPlansPlanRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/plans/{plan}

The same as postPlansPlan but returns the raw ByteString

postPlansPlanM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPlansPlanResponse)) Source #

POST /v1/plans/{plan}

Monadic version of postPlansPlan (use with runWithConfiguration)

postPlansPlanRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPlansPlanRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/plans/{plan}

Monadic version of postPlansPlanRaw (use with runWithConfiguration)

data PostPlansPlanRequestBody Source #

Defines the data type for the schema postPlansPlanRequestBody

Constructors

PostPlansPlanRequestBody

Fields

postPlansPlanRequestBodyActive :: Maybe Bool
active: Whether the plan is currently available for new subscriptions.
postPlansPlanRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postPlansPlanRequestBodyMetadata :: Maybe PostPlansPlanRequestBodyMetadata'
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`.
postPlansPlanRequestBodyNickname :: Maybe Text
nickname: A brief description of the plan, hidden from customers.
Constraints:
- Maximum length of 5000
postPlansPlanRequestBodyProduct :: Maybe Text
product: The product the plan belongs to. Note that after updating, statement descriptors and line items of the plan in active subscriptions will be affected.
Constraints:
- Maximum length of 5000
postPlansPlanRequestBodyTrialPeriodDays :: Maybe Integer
trial_period_days: Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`.

Instances

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

data PostPlansPlanRequestBodyMetadata' Source #

Defines the data type for the schema postPlansPlanRequestBodyMetadata'

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

PostPlansPlanRequestBodyMetadata'

Instances

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

data PostPlansPlanResponse Source #

Represents a response of the operation postPlansPlan.

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

Constructors

PostPlansPlanResponseError String	Means either no matching case available or a parse error
PostPlansPlanResponse200 Plan	Successful response.
PostPlansPlanResponseDefault Error	Error response.

Instances

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