Stripe Product
Stripe Product manages the product catalogue of your Stripe account. A product is what you sell, an item or a service, with its name, description and other details. The amount does not go on the product but on its prices, which you create with Stripe Price.
When to use it
- You add an item to your shop or ERP and want it to appear in Stripe too.
- You change the description or web page of a service and want to update it in Stripe.
- You want to take a product off sale by marking it inactive.
- You want to list the active products to review your catalogue.
Configuration
You need a Stripe API credential with the secret key of your Stripe account. See Credentials.
| Field | What it does |
|---|---|
| Credential (required) | The Stripe API credential of your account. |
| Operation (required) | The action the component performs. Defaults to Create. See Operations. |
| Mode | Only in Get. By ID looks up one product; All returns the list of products. Defaults to By ID. |
| Product ID | The product’s identifier in Stripe (starts with prod_). Required in Delete, Update and Get with By ID. |
| Name | The product’s name. Required in Create; in Update, only if you want to change it. |
| Description | The product’s description. In Create and Update. |
| Active | In Create and Update, true keeps it on sale and false takes it off sale. In Get with All, returns only active (true) or inactive (false) products. Left empty, nothing is changed or filtered. |
| URL | The address of the product’s public page. In Create and Update. |
| Unit Label | What one unit of the product is called on receipts and invoices, for example license or seat. In Create and Update. |
| Shippable | true if the product is shipped physically, false if not. In Create and Update. |
| Statement Descriptor | The text the customer sees on their card statement. Up to 22 characters. In Create and Update. |
| Tax Code | The Stripe Tax code that applies to the product, for example txcd_10000000. In Create and Update. |
| Limit | Only in Get with All. Maximum number of products returned, between 1 and 100. Defaults to 100. |
In Update only the fields you fill in are changed; empty ones stay as they were.
Operations
- Create: creates a new product in your catalogue.
- Delete: deletes a product. Stripe only allows it if the product has no prices; if it has, mark it inactive with Update.
- Get: with
By IDreturns one product; withAllreturns the list, filtered by active or inactive if you choose. - Update: changes the details of an existing product.
Output
The Data output returns the product that was created, looked up, updated or deleted. With Get and All, it returns one item per product. Each item includes the product’s identifier, which you will need in Stripe Price and Stripe Plan.
The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.
Example
A software company adds every new license in its catalogue to Stripe.
- When the new product is approved in your catalogue sheet, the flow receives its name and description.
- Add Stripe Product with Operation set to
Createand pass those values to Name and Description. - Set Unit Label to
licenseand Statement Descriptor toMYCOMPANY SOFTWARE. - Connect the Data output to Stripe Price to create its yearly price.
Related components
- Stripe Price: prices of your products.
- Stripe Plan: recurring payment plans.
- Stripe Subscription: your customers’ subscriptions.