Reference

Endpoint List All Products

Name

get_products

Description

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

Related Tables

Products

Parameters

Parameter Required Options
Name: active

Label: Active

Only return products that are active or inactive (e.g., pass false to list all inactive products).
Option Value
True True
False False
Name: created_gt

Label: Created later than (yyyy-MM-dd)

Return results where the created field is greater than this value.
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Name: created_gte

Label: Created on or later than (yyyy-MM-dd)

Return results where the created field is greater than or equal to this value.
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Name: created_lt

Label: Created earlier than (yyyy-MM-dd)

Return results where the created field is less than this value.
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Name: created_lte

Label: Created on or earlier than (yyyy-MM-dd)

Return results where the created field is less than or equal to this value.
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
Name DT_WSTR nvarchar(100) 100
Caption DT_WSTR nvarchar(4000) 4000
Description DT_WSTR nvarchar(4000) 4000
Active DT_BOOL bit
Created DT_DBTIMESTAMP datetime
Updated DT_DBTIMESTAMP datetime
Type DT_WSTR nvarchar(100) 100
Object DT_WSTR nvarchar(100) 100
Attributes DT_WSTR nvarchar(2000) 2000
LiveMode DT_BOOL bit
StatementDescription DT_WSTR nvarchar(4000) 4000
UnitLabel DT_WSTR nvarchar(4000) 4000
PackageDimensionsHeight DT_WSTR nvarchar(4000) 4000
PackageDimensionsLength DT_WSTR nvarchar(4000) 4000
PackageDimensionsWidth DT_WSTR nvarchar(4000) 4000
PackageDimensionsWeight DT_WSTR nvarchar(4000) 4000
URL DT_WSTR nvarchar(4000) 4000
Images DT_WSTR nvarchar(2000) 2000
TaxCodeId DT_WSTR nvarchar(4000) 4000
TaxCodeName DT_WSTR nvarchar(4000) 4000
PriceUnitAmount DT_I8 bigint
PriceRecurringInterval DT_WSTR nvarchar(4000) 4000
PriceRecurringIntervalCount DT_I4 int
PriceRecurringUsageType DT_WSTR nvarchar(4000) 4000
Shippable DT_WSTR nvarchar(4000) 4000
DeactivatedOn DT_DBTIMESTAMP datetime
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Products table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Products
Optional Parameters
Active
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Products table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list all products:

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Products
Select
Optional Parameters
Active
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get all Products

Read all products 

SELECT * FROM Products

get_products endpoint belongs to Products table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get all Products

Read all products 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Products';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

get_products endpoint belongs to Products table(s), and can therefore be used via those table(s).