steampipe plugin install stripe

Table: stripe_product - Query Stripe Products using SQL

Stripe Products is a resource within the Stripe payment processing service that represents the different products or services that a business offers. It provides a way to define and manage the catalog of items for which a business accepts payments. Stripe Products facilitates the organization of these items, including their pricing, description, and other related information.

Table Usage Guide

The stripe_product table provides insights into the various products or services within Stripe's payment processing service. As a financial analyst or business owner, explore product-specific details through this table, including product ID, name, description, and active status. Utilize it to manage and organize your product catalog, monitor active products, and gain a comprehensive overview of your business offerings.

Examples

List all products

Explore all available products in your inventory to manage and oversee your product catalog more efficiently. This can help you keep track of your offerings and make strategic decisions based on the comprehensive overview.

select
*
from
stripe_product;
select
*
from
stripe_product;

All products that are not active

Explore which of your Stripe products are currently inactive. This can be useful for identifying items that may need updating or reactivation, helping to ensure your product offerings remain current and relevant.

select
*
from
stripe_product
where
not active;
select
*
from
stripe_product
where
active = 0;

Schema for stripe_product

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
activeboolean=, !=Whether the product is currently available for purchase.
createdtimestamp with time zone>, >=, =, <, <=Time at which the product was created.
descriptiontextAn arbitrary string attached to the product. Often useful for displaying to users.
idtext=Unique identifier for the product.
imagesjsonbA list of up to 8 URLs of images for this product, meant to be displayable to the customer.
livemodebooleanHas the value true if the product exists in live mode or the value false if the product exists in test mode.
metadatajsonbSet of key-value pairs that you can attach to an product. This can be useful for storing additional information about the product in a structured format.
nametextThe product’s full name or business name.
package_dimensionsjsonbThe dimensions of this product for shipping purposes.
shippableboolean=, !=Whether this product is shipped (i.e., physical goods).
statement_descriptortextExtra 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.
typetextThe product type.
unit_labeltextA label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
updatedtimestamp with time zoneTime at which the product was updated.
urltext=A URL of a publicly-accessible webpage for this product.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- stripe

You can pass the configuration to the command with the --config argument:

steampipe_export_stripe --config '<your_config>' stripe_product