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

The Product object 

Products
Products
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

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

  • createdtimestamp

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

  • imagesarray of strings

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

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • marketing_featuresarray of objects

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

    • marketing_features.namenullable string

      The marketing feature name. Up to 80 characters long.

  • package_dimensionsnullable object

    The dimensions of this product for shipping purposes.

    • package_dimensions.heightfloat

      Height, in inches.

    • package_dimensions.lengthfloat

      Length, in inches.

    • package_dimensions.weightfloat

      Weight, in ounces.

    • package_dimensions.widthfloat

      Width, in inches.

  • shippablenullable boolean

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

  • statement_descriptornullable string

    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_labelnullable string

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

  • updatedtimestamp

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

  • urlnullable string

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

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
}