stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPlansPlan

Description

Contains the different functions to run the operation postPlansPlan

Synopsis

Documentation

postPlansPlan Source #

Arguments

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

The configuration to use in the request

-> String

plan | Constraints: Maximum length of 5000

-> 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 -> String -> PostPlansPlanRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/plans/{plan}

The same as postPlansPlan but returns the raw ByteString

data PostPlansPlanRequestBody Source #

Defines the data type for the schema postPlansPlanRequestBody

Constructors

PostPlansPlanRequestBody 

Fields

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

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.