The Product object

Attributes

idstring
Unique identifier for the object.

activeboolean
Whether the product is currently available for purchase.

default_pricenullable stringExpandable
The ID of the Price object that is the default price for this product.

descriptionnullable string
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.

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.

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

tax_codenullable stringExpandable
A tax code ID.

More attributes

objectstring

createdtimestamp

imagesarray of strings

livemodeboolean

marketing_featuresarray of objects

package_dimensionsnullable object

shippablenullable boolean

statement_descriptornullable string

unit_labelnullable string

updatedtimestamp

urlnullable string

The Product object

{
  "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
}

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

imagesarray of strings

marketing_featuresarray of objects

package_dimensionsobject

shippableboolean

statement_descriptorstring

unit_labelstring

urlstring

Returns

Returns a product object if the call succeeded.

POST /v1/products

Server-side language

curl https://api.stripe.com/v1/products \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d 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
}

Update a product

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

Parameters

activeboolean
Whether the product is available for purchase.

default_pricestring
The ID of the Price object that is the default price for this product.

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.

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
The product’s name, meant to be displayable to the customer.

tax_codestringRecommended if calculating taxes
A tax code ID.

More parameters

imagesarray of strings

marketing_featuresarray of objects

package_dimensionsobject

shippableboolean

statement_descriptorstring

unit_labelstring

urlstring

Returns

Returns the product object if the update succeeded.

POST /v1/products/:id

Server-side language

curl https://api.stripe.com/v1/products/prod_NWjs8kKbJWmuuc \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d "metadata[order_id]"=6735

Response

{
  "id": "prod_NWjs8kKbJWmuuc",
  "object": "product",
  "active": true,
  "created": 1678833149,
  "default_price": null,
  "description": null,
  "images": [],
  "marketing_features": [],
  "livemode": false,
  "metadata": {
    "order_id": "6735"
  },
  "name": "Gold Plan",
  "package_dimensions": null,
  "shippable": null,
  "statement_descriptor": null,
  "tax_code": null,
  "unit_label": null,
  "updated": 1678833149,
  "url": null
}

Retrieve a product

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Parameters

No parameters.

Returns

Returns a product object if a valid identifier was provided.

GET /v1/products/:id

Server-side language

curl https://api.stripe.com/v1/products/prod_NWjs8kKbJWmuuc \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

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
}

List all products

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Parameters

activeboolean
Only return products that are active or inactive (e.g., pass false to list all inactive products).

More parameters

createdobject

ending_beforestring

idsarray of strings

limitinteger

shippableboolean

starting_afterstring

urlstring

Returns

A dictionary with a data property that contains an array of up to limit products, starting after product starting_after. Each entry in the array is a separate product object. If no more products are available, the resulting array will be empty.

GET /v1/products

Server-side language

curl -G https://api.stripe.com/v1/products \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/products",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

The Product object

Attributes

idstring

activeboolean

default_pricenullable stringExpandable

descriptionnullable string

metadataobject

namestring

tax_codenullable stringExpandable

More attributesExpand all

objectstring

createdtimestamp

imagesarray of strings

livemodeboolean

marketing_featuresarray of objects

package_dimensionsnullable object

shippablenullable boolean

statement_descriptornullable string

unit_labelnullable string

updatedtimestamp

urlnullable string

Create a product

Parameters

namestringRequired

activeboolean

descriptionstring

idstring

metadataobject

tax_codestringRecommended if calculating taxes

More parametersExpand all

default_price_dataobject

imagesarray of strings

marketing_featuresarray of objects

package_dimensionsobject

shippableboolean

statement_descriptorstring

unit_labelstring

urlstring

Returns

Update a product

Parameters

activeboolean

default_pricestring

descriptionstring

metadataobject

namestring

tax_codestringRecommended if calculating taxes

More parametersExpand all

imagesarray of strings

marketing_featuresarray of objects

package_dimensionsobject

shippableboolean

statement_descriptorstring

unit_labelstring

urlstring

Returns

Retrieve a product

Parameters

Returns

List all products

Parameters

activeboolean

More parametersExpand all

createdobject

ending_beforestring

idsarray of strings

limitinteger

shippableboolean

starting_afterstring

urlstring

Returns

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

More attributes

More parameters

More parameters

More parameters