Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostProducts

Contains the different functions to run the operation postProducts

7 types
5 values

Packagestripeapi-3.0.0.0
Exports12
LanguageHaskell2010
LicenceMIT
SourcePostProducts.hs

valuepostProducts

:: MonadHTTP m
=> PostProductsRequestBody
The request body to send
-> ClientT m (Response PostProductsResponse)
Monadic computation which returns the result of the operation

POST /v1/products

<p>Creates a new product object.</p>

datadata PostProductsRequestBody

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

Constructors

PostProductsRequestBody
- postProductsRequestBodyActive :: Maybe Bool
  active: Whether the product is currently available for purchase. Defaults to `true`.
- postProductsRequestBodyDefaultPriceData :: Maybe PostProductsRequestBodyDefaultPriceData'
  default_price_data: Data used to generate a new Price object. This Price will be set as the default price for this product.
- postProductsRequestBodyDescription :: 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
- postProductsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postProductsRequestBodyId :: Maybe Text
  id: An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
  Constraints:
  - Maximum length of 5000
- postProductsRequestBodyImages :: Maybe [Text]
  images: A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
- postProductsRequestBodyMetadata :: Maybe Object
  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`.
- postProductsRequestBodyName :: Text
  name: The product's name, meant to be displayable to the customer.
  Constraints:
  - Maximum length of 5000
- postProductsRequestBodyPackageDimensions :: Maybe PostProductsRequestBodyPackageDimensions'
  package_dimensions: The dimensions of this product for shipping purposes.
- postProductsRequestBodyShippable :: Maybe Bool
  shippable: Whether this product is shipped (i.e., physical goods).
- postProductsRequestBodyStatementDescriptor :: 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.
  Constraints:
  - Maximum length of 22
- postProductsRequestBodyTaxCode :: Maybe Text
  tax_code: A tax code ID.
- postProductsRequestBodyUnitLabel :: 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.
  Constraints:
  - Maximum length of 12
- postProductsRequestBodyUrl :: Maybe Text
  url: A URL of a publicly-accessible webpage for this product.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

valuemkPostProductsRequestBody

:: Text
postProductsRequestBodyName
-> PostProductsRequestBody

Create a new PostProductsRequestBody with all required fields.

datadata PostProductsRequestBodyDefaultPriceData'

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

Data used to generate a new Price object. This Price will be set as the default price for this product.

Constructors

PostProductsRequestBodyDefaultPriceData'
- postProductsRequestBodyDefaultPriceData'Currency :: Text
  currency
- postProductsRequestBodyDefaultPriceData'Recurring :: Maybe PostProductsRequestBodyDefaultPriceData'Recurring'
  recurring
- postProductsRequestBodyDefaultPriceData'TaxBehavior :: Maybe PostProductsRequestBodyDefaultPriceData'TaxBehavior'
  tax_behavior
- postProductsRequestBodyDefaultPriceData'UnitAmount :: Maybe Int
  unit_amount
- postProductsRequestBodyDefaultPriceData'UnitAmountDecimal :: Maybe Text
  unit_amount_decimal

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyDefaultPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyDefaultPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyDefaultPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyDefaultPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

valuemkPostProductsRequestBodyDefaultPriceData'

:: Text
postProductsRequestBodyDefaultPriceData'Currency
-> PostProductsRequestBodyDefaultPriceData'

Create a new PostProductsRequestBodyDefaultPriceData' with all required fields.

datadata PostProductsRequestBodyDefaultPriceData'Recurring'

Defines the object schema located at paths./v1/products.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_price_data.properties.recurring in the specification.

Constructors

PostProductsRequestBodyDefaultPriceData'Recurring'
- postProductsRequestBodyDefaultPriceData'Recurring'Interval :: PostProductsRequestBodyDefaultPriceData'Recurring'Interval'
  interval
- postProductsRequestBodyDefaultPriceData'Recurring'IntervalCount :: Maybe Int
  interval_count

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyDefaultPriceData'Recurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyDefaultPriceData'Recurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyDefaultPriceData'Recurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyDefaultPriceData'Recurring'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

valuemkPostProductsRequestBodyDefaultPriceData'Recurring'

:: PostProductsRequestBodyDefaultPriceData'Recurring'Interval'
postProductsRequestBodyDefaultPriceData'Recurring'Interval
-> PostProductsRequestBodyDefaultPriceData'Recurring'

Create a new PostProductsRequestBodyDefaultPriceData'Recurring' with all required fields.

datadata PostProductsRequestBodyDefaultPriceData'Recurring'Interval'

Defines the enum schema located at paths./v1/products.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_price_data.properties.recurring.properties.interval in the specification.

Constructors

PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostProductsRequestBodyDefaultPriceData'Recurring'Interval'EnumDay
Represents the JSON value "day"
PostProductsRequestBodyDefaultPriceData'Recurring'Interval'EnumMonth
Represents the JSON value "month"
PostProductsRequestBodyDefaultPriceData'Recurring'Interval'EnumWeek
Represents the JSON value "week"
PostProductsRequestBodyDefaultPriceData'Recurring'Interval'EnumYear
Represents the JSON value "year"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyDefaultPriceData'Recurring'Interval'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

datadata PostProductsRequestBodyDefaultPriceData'TaxBehavior'

Defines the enum schema located at paths./v1/products.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_price_data.properties.tax_behavior in the specification.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyDefaultPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyDefaultPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyDefaultPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyDefaultPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

datadata PostProductsRequestBodyPackageDimensions'

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

The dimensions of this product for shipping purposes.

Constructors

PostProductsRequestBodyPackageDimensions'
- postProductsRequestBodyPackageDimensions'Height :: Double
  height
- postProductsRequestBodyPackageDimensions'Length :: Double
  length
- postProductsRequestBodyPackageDimensions'Weight :: Double
  weight
- postProductsRequestBodyPackageDimensions'Width :: Double
  width

Instances4Eq, Show, FromJSON, ToJSON

Eq PostProductsRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
FromJSON PostProductsRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
ToJSON PostProductsRequestBodyPackageDimensions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts

valuemkPostProductsRequestBodyPackageDimensions'

:: Double
postProductsRequestBodyPackageDimensions'Height
-> Double
postProductsRequestBodyPackageDimensions'Length
-> Double
postProductsRequestBodyPackageDimensions'Weight
-> Double
postProductsRequestBodyPackageDimensions'Width
-> PostProductsRequestBodyPackageDimensions'

Create a new PostProductsRequestBodyPackageDimensions' with all required fields.

datadata PostProductsResponse

Represents a response of the operation postProducts.

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

Constructors

PostProductsResponseError String
Means either no matching case available or a parse error
PostProductsResponse200 Product
Successful response.
PostProductsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostProductsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts
Show PostProductsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostProducts