StripeAPI.Operations.PostProductsId

Contains the different functions to run the operation postProductsId

Documentation

postProductsId

Arguments

:: forall m. MonadHTTP m

=> Text

id | Constraints: Maximum length of 5000

-> Maybe PostProductsIdRequestBody

The request body to send

-> StripeT m (Response PostProductsIdResponse)

Monadic computation which returns the result of the operation

POST /v1/products/{id}

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

data PostProductsIdRequestBody

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

Constructors

PostProductsIdRequestBody

Fields

• postProductsIdRequestBodyActive :: Maybe Bool

  active: Whether the product is available for purchase.

• postProductsIdRequestBodyDescription :: Maybe Text

  description: The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

  Constraints:

  • Maximum length of 40000
• postProductsIdRequestBodyExpand :: Maybe [Text]

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

• postProductsIdRequestBodyImages :: Maybe PostProductsIdRequestBodyImages'Variants

  images: A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

• postProductsIdRequestBodyMetadata :: Maybe PostProductsIdRequestBodyMetadata'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`.

• postProductsIdRequestBodyName :: Maybe Text

  name: The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

  Constraints:

  • Maximum length of 5000
• postProductsIdRequestBodyPackageDimensions :: Maybe PostProductsIdRequestBodyPackageDimensions'Variants

  package_dimensions: The dimensions of this product for shipping purposes.

• postProductsIdRequestBodyShippable :: Maybe Bool

  shippable: Whether this product is shipped (i.e., physical goods).

• postProductsIdRequestBodyStatementDescriptor :: Maybe Text

  statement_descriptor: An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.

  This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if `type=service`.

  Constraints:

  • Maximum length of 22
• postProductsIdRequestBodyTaxCode :: Maybe PostProductsIdRequestBodyTaxCode'Variants

  tax_code: A tax code ID.

• postProductsIdRequestBodyUnitLabel :: Maybe Text

  unit_label: A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions. May only be set if `type=service`.

  Constraints:

  • Maximum length of 12
• postProductsIdRequestBodyUrl :: Maybe Text

  url: A URL of a publicly-accessible webpage for this product.

Instances

Eq PostProductsIdRequestBody

Defined in StripeAPI.Operations.PostProductsId

Methods

(==) :: PostProductsIdRequestBody -> PostProductsIdRequestBody -> Bool

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

Show PostProductsIdRequestBody

Defined in StripeAPI.Operations.PostProductsId

Methods

showsPrec :: Int -> PostProductsIdRequestBody -> ShowS

show :: PostProductsIdRequestBody -> String

showList :: [PostProductsIdRequestBody] -> ShowS

ToJSON PostProductsIdRequestBody

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBody -> Value

toEncoding :: PostProductsIdRequestBody -> Encoding

toJSONList :: [PostProductsIdRequestBody] -> Value

toEncodingList :: [PostProductsIdRequestBody] -> Encoding

FromJSON PostProductsIdRequestBody

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBody

parseJSONList :: Value -> Parser [PostProductsIdRequestBody]

mkPostProductsIdRequestBody :: PostProductsIdRequestBody

Create a new PostProductsIdRequestBody with all required fields.

data PostProductsIdRequestBodyImages'Variants

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

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

Constructors

PostProductsIdRequestBodyImages'EmptyString

Represents the JSON value ""

PostProductsIdRequestBodyImages'ListTText [Text]

Instances

Eq PostProductsIdRequestBodyImages'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

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

Show PostProductsIdRequestBodyImages'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

show :: PostProductsIdRequestBodyImages'Variants -> String

showList :: [PostProductsIdRequestBodyImages'Variants] -> ShowS

ToJSON PostProductsIdRequestBodyImages'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBodyImages'Variants -> Value

toEncoding :: PostProductsIdRequestBodyImages'Variants -> Encoding

toJSONList :: [PostProductsIdRequestBodyImages'Variants] -> Value

toEncodingList :: [PostProductsIdRequestBodyImages'Variants] -> Encoding

FromJSON PostProductsIdRequestBodyImages'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBodyImages'Variants

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

data PostProductsIdRequestBodyMetadata'Variants

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

PostProductsIdRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostProductsIdRequestBodyMetadata'Object Object

Instances

Eq PostProductsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

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

Show PostProductsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

show :: PostProductsIdRequestBodyMetadata'Variants -> String

showList :: [PostProductsIdRequestBodyMetadata'Variants] -> ShowS

ToJSON PostProductsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBodyMetadata'Variants -> Value

toEncoding :: PostProductsIdRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostProductsIdRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostProductsIdRequestBodyMetadata'Variants] -> Encoding

FromJSON PostProductsIdRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBodyMetadata'Variants

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

data PostProductsIdRequestBodyPackageDimensions'OneOf1

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

Constructors

PostProductsIdRequestBodyPackageDimensions'OneOf1

Fields

• postProductsIdRequestBodyPackageDimensions'OneOf1Height :: Double

  height

• postProductsIdRequestBodyPackageDimensions'OneOf1Length :: Double

  length

• postProductsIdRequestBodyPackageDimensions'OneOf1Weight :: Double

  weight

• postProductsIdRequestBodyPackageDimensions'OneOf1Width :: Double

  width

Instances

Eq PostProductsIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostProductsId

Methods

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

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

Show PostProductsIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostProductsId

Methods

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

show :: PostProductsIdRequestBodyPackageDimensions'OneOf1 -> String

showList :: [PostProductsIdRequestBodyPackageDimensions'OneOf1] -> ShowS

ToJSON PostProductsIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBodyPackageDimensions'OneOf1 -> Value

toEncoding :: PostProductsIdRequestBodyPackageDimensions'OneOf1 -> Encoding

toJSONList :: [PostProductsIdRequestBodyPackageDimensions'OneOf1] -> Value

toEncodingList :: [PostProductsIdRequestBodyPackageDimensions'OneOf1] -> Encoding

FromJSON PostProductsIdRequestBodyPackageDimensions'OneOf1

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBodyPackageDimensions'OneOf1

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

mkPostProductsIdRequestBodyPackageDimensions'OneOf1

Arguments

:: Double

postProductsIdRequestBodyPackageDimensions'OneOf1Height

-> Double

postProductsIdRequestBodyPackageDimensions'OneOf1Length

-> Double

postProductsIdRequestBodyPackageDimensions'OneOf1Weight

-> Double

postProductsIdRequestBodyPackageDimensions'OneOf1Width

-> PostProductsIdRequestBodyPackageDimensions'OneOf1

Create a new PostProductsIdRequestBodyPackageDimensions'OneOf1 with all required fields.

data PostProductsIdRequestBodyPackageDimensions'Variants

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

The dimensions of this product for shipping purposes.

Constructors

PostProductsIdRequestBodyPackageDimensions'EmptyString

Represents the JSON value ""

PostProductsIdRequestBodyPackageDimensions'PostProductsIdRequestBodyPackageDimensions'OneOf1 PostProductsIdRequestBodyPackageDimensions'OneOf1

Instances

Eq PostProductsIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

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

Show PostProductsIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

show :: PostProductsIdRequestBodyPackageDimensions'Variants -> String

showList :: [PostProductsIdRequestBodyPackageDimensions'Variants] -> ShowS

ToJSON PostProductsIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBodyPackageDimensions'Variants -> Value

toEncoding :: PostProductsIdRequestBodyPackageDimensions'Variants -> Encoding

toJSONList :: [PostProductsIdRequestBodyPackageDimensions'Variants] -> Value

toEncodingList :: [PostProductsIdRequestBodyPackageDimensions'Variants] -> Encoding

FromJSON PostProductsIdRequestBodyPackageDimensions'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBodyPackageDimensions'Variants

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

data PostProductsIdRequestBodyTaxCode'Variants

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

A tax code ID.

Constructors

PostProductsIdRequestBodyTaxCode'EmptyString

Represents the JSON value ""

PostProductsIdRequestBodyTaxCode'Text Text

Instances

Eq PostProductsIdRequestBodyTaxCode'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

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

Show PostProductsIdRequestBodyTaxCode'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

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

show :: PostProductsIdRequestBodyTaxCode'Variants -> String

showList :: [PostProductsIdRequestBodyTaxCode'Variants] -> ShowS

ToJSON PostProductsIdRequestBodyTaxCode'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

toJSON :: PostProductsIdRequestBodyTaxCode'Variants -> Value

toEncoding :: PostProductsIdRequestBodyTaxCode'Variants -> Encoding

toJSONList :: [PostProductsIdRequestBodyTaxCode'Variants] -> Value

toEncodingList :: [PostProductsIdRequestBodyTaxCode'Variants] -> Encoding

FromJSON PostProductsIdRequestBodyTaxCode'Variants

Defined in StripeAPI.Operations.PostProductsId

Methods

parseJSON :: Value -> Parser PostProductsIdRequestBodyTaxCode'Variants

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

data PostProductsIdResponse

Represents a response of the operation postProductsId.

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

Constructors

PostProductsIdResponseError String

Means either no matching case available or a parse error

PostProductsIdResponse200 Product

Successful response.

PostProductsIdResponseDefault Error

Error response.

Instances

Eq PostProductsIdResponse

Defined in StripeAPI.Operations.PostProductsId

Methods

(==) :: PostProductsIdResponse -> PostProductsIdResponse -> Bool

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

Show PostProductsIdResponse

Defined in StripeAPI.Operations.PostProductsId

Methods

showsPrec :: Int -> PostProductsIdResponse -> ShowS

show :: PostProductsIdResponse -> String

showList :: [PostProductsIdResponse] -> ShowS