StripeAPI.Operations.PostPlansPlan

Contains the different functions to run the operation postPlansPlan

Documentation

postPlansPlan

Arguments

:: forall m. MonadHTTP m

=> Text

plan | Constraints: Maximum length of 5000

-> Maybe PostPlansPlanRequestBody

The request body to send

-> ClientT m (Response PostPlansPlanResponse)

Monadic computation which returns 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>

data PostPlansPlanRequestBody

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

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

• 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. This cannot be changed once it has been used in a subscription or subscription schedule.

  Constraints:

  • Maximum length of 5000
• postPlansPlanRequestBodyTrialPeriodDays :: Maybe Int

  trial_period_days: Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`.

Instances

Eq PostPlansPlanRequestBody

Defined in StripeAPI.Operations.PostPlansPlan

Methods

(==) :: PostPlansPlanRequestBody -> PostPlansPlanRequestBody -> Bool

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

Show PostPlansPlanRequestBody

Defined in StripeAPI.Operations.PostPlansPlan

Methods

showsPrec :: Int -> PostPlansPlanRequestBody -> ShowS

show :: PostPlansPlanRequestBody -> String

showList :: [PostPlansPlanRequestBody] -> ShowS

ToJSON PostPlansPlanRequestBody

Defined in StripeAPI.Operations.PostPlansPlan

Methods

toJSON :: PostPlansPlanRequestBody -> Value

toEncoding :: PostPlansPlanRequestBody -> Encoding

toJSONList :: [PostPlansPlanRequestBody] -> Value

toEncodingList :: [PostPlansPlanRequestBody] -> Encoding

FromJSON PostPlansPlanRequestBody

Defined in StripeAPI.Operations.PostPlansPlan

Methods

parseJSON :: Value -> Parser PostPlansPlanRequestBody

parseJSONList :: Value -> Parser [PostPlansPlanRequestBody]

mkPostPlansPlanRequestBody :: PostPlansPlanRequestBody

Create a new PostPlansPlanRequestBody with all required fields.

data PostPlansPlanRequestBodyMetadata'Variants

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

PostPlansPlanRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostPlansPlanRequestBodyMetadata'Object Object

Instances

Eq PostPlansPlanRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPlansPlan

Methods

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

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

Show PostPlansPlanRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPlansPlan

Methods

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

show :: PostPlansPlanRequestBodyMetadata'Variants -> String

showList :: [PostPlansPlanRequestBodyMetadata'Variants] -> ShowS

ToJSON PostPlansPlanRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPlansPlan

Methods

toJSON :: PostPlansPlanRequestBodyMetadata'Variants -> Value

toEncoding :: PostPlansPlanRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostPlansPlanRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostPlansPlanRequestBodyMetadata'Variants] -> Encoding

FromJSON PostPlansPlanRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPlansPlan

Methods

parseJSON :: Value -> Parser PostPlansPlanRequestBodyMetadata'Variants

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

data PostPlansPlanResponse

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

Defined in StripeAPI.Operations.PostPlansPlan

Methods

(==) :: PostPlansPlanResponse -> PostPlansPlanResponse -> Bool

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

Show PostPlansPlanResponse

Defined in StripeAPI.Operations.PostPlansPlan

Methods

showsPrec :: Int -> PostPlansPlanResponse -> ShowS

show :: PostPlansPlanResponse -> String

showList :: [PostPlansPlanResponse] -> ShowS