Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create a product 

Products
Products
Create a product

Creates a new product object.

Parameters

  • namestringRequired

    The product’s name, meant to be displayable to the customer.

  • activeboolean

    Whether the product is currently available for purchase. Defaults to true.

  • descriptionstring

    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.

  • idstring

    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.

  • metadataobject

    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.

  • tax_codestringRecommended if calculating taxes

    A tax code ID.

More parameters

  • default_price_dataobject

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

    • default_price_data.currencyenumRequired

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • default_price_data.currency_optionsobject

      Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

      • default_price_data.currency_options.<currency>.custom_unit_amountobjectRequired conditionally

        When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

        • default_price_data.currency_options.<currency>.custom_unit_amount.enabledbooleanRequired

          Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.

        • default_price_data.currency_options.<currency>.custom_unit_amount.maximuminteger

          The maximum unit amount the customer can specify for this item.

        • default_price_data.currency_options.<currency>.custom_unit_amount.minimuminteger

          The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

        • default_price_data.currency_options.<currency>.custom_unit_amount.presetinteger

          The starting unit amount which can be updated by the customer.

      • default_price_data.currency_options.<currency>.tax_behaviorenumRecommended if calculating taxes

        Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

        Possible enum values
        exclusive
        inclusive
        unspecified

      • default_price_data.currency_options.<currency>.tiersarray of objectsRequired if billing_scheme=tiered

        Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

        • default_price_data.currency_options.<currency>.tiers.up_tostring | integerRequired

          Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.

        • default_price_data.currency_options.<currency>.tiers.flat_amountinteger

          The flat billing amount for an entire tier, regardless of the number of units in the tier.

        • default_price_data.currency_options.<currency>.tiers.flat_amount_decimalstring

          Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.

        • default_price_data.currency_options.<currency>.tiers.unit_amountinteger

          The per unit billing amount for each individual unit for which this tier applies.

        • default_price_data.currency_options.<currency>.tiers.unit_amount_decimalstring

          Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

      • default_price_data.currency_options.<currency>.unit_amountintegerRequired conditionally

        A positive integer in cents (or 0 for a free price) representing how much to charge.

      • default_price_data.currency_options.<currency>.unit_amount_decimalstringRequired conditionally

        Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    • default_price_data.custom_unit_amountobjectRequired unless unit_amount is provided

      When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

      • default_price_data.custom_unit_amount.enabledbooleanRequired

        Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.

      • default_price_data.custom_unit_amount.maximuminteger

        The maximum unit amount the customer can specify for this item.

      • default_price_data.custom_unit_amount.minimuminteger

        The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

      • default_price_data.custom_unit_amount.presetinteger

        The starting unit amount which can be updated by the customer.

    • default_price_data.metadataobject

      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.

    • default_price_data.recurringobject

      The recurring components of a price such as interval and interval_count.

      • default_price_data.recurring.intervalenumRequired

        Specifies billing frequency. Either day, week, month or year.

        Possible enum values
        day
        month
        week
        year

      • default_price_data.recurring.interval_countinteger

        The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

    • default_price_data.tax_behaviorenumRecommended if calculating taxes

      Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

      Possible enum values
      exclusive
      inclusive
      unspecified

    • default_price_data.unit_amountintegerRequired conditionally

      A positive integer in cents (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.

    • default_price_data.unit_amount_decimalstringRequired conditionally

      Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

  • imagesarray of strings

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

  • marketing_featuresarray of objects

    A list of up to 15 marketing features for this product. These are displayed in pricing tables.

    • marketing_features.namestringRequired

      The marketing feature name. Up to 80 characters long.

  • package_dimensionsobject

    The dimensions of this product for shipping purposes.

    • package_dimensions.heightfloatRequired

      Height, in inches. Maximum precision is 2 decimal places.

    • package_dimensions.lengthfloatRequired

      Length, in inches. Maximum precision is 2 decimal places.

    • package_dimensions.weightfloatRequired

      Weight, in ounces. Maximum precision is 2 decimal places.

    • package_dimensions.widthfloatRequired

      Width, in inches. Maximum precision is 2 decimal places.

  • shippableboolean

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

  • statement_descriptorstring

    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. Only used for subscription payments.

  • unit_labelstring

    A label that represents units of this product. When set, this will be included in customers’ receipts, invoices, Checkout, and the customer portal.

  • urlstring

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

Returns

Returns a product object if the call succeeded.

POST /v1/products
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const product = await stripe.products.create({
  name: 'Gold Plan',
});
Response
{
  "id": "prod_NWjs8kKbJWmuuc",
  "object": "product",
  "active": true,
  "created": 1678833149,
  "default_price": null,
  "description": null,
  "images": [],
  "marketing_features": [],
  "livemode": false,
  "metadata": {},
  "name": "Gold Plan",
  "package_dimensions": null,
  "shippable": null,
  "statement_descriptor": null,
  "tax_code": null,
  "unit_label": null,
  "updated": 1678833149,
  "url": null
}