Create a product

Changed on

Creates a new product object.

post/v1/products

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/products
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

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.

expandstring[]

Specifies which fields in the response should be expanded.

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.

imagesstring[]

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

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.

namestring required

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

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.

tax_codestring

A tax code ID.

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.

Response

Successful response.

activeboolean required

Whether the product is currently available for purchase.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

descriptionstring nullable

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 required

Unique identifier for the object.

imagesstring[] required

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

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

namestring required

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

object'product' required

String representing the object's type. Objects of the same type share the same value.

shippableboolean nullable

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

statement_descriptorstring nullable

Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

unit_labelstring nullable

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

updatedinteger required

Time at which the object was last updated. Measured in seconds since the Unix epoch.

urlstring nullable

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

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.