Endpoint Retrieve a single Subscription
Name
get_single_subscription
Description
Returns a single subscription. [API reference]
Related Tables
Parameters
Parameter | Required | Options |
---|---|---|
Name:
Label: Subscription Id Unique identifier for the Subscription |
YES |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(180)
|
180 | |
Object |
DT_WSTR
|
nvarchar(120)
|
120 | |
Application |
DT_WSTR
|
nvarchar(255)
|
255 | |
ApplicationFeePercent |
DT_WSTR
|
nvarchar(255)
|
255 | |
AutomaticTaxEnabled |
DT_BOOL
|
bit
|
||
BillingCycleAnchor |
DT_DBTIMESTAMP
|
datetime
|
||
BillingThresholds |
DT_WSTR
|
nvarchar(255)
|
255 | |
CancelAt |
DT_DBTIMESTAMP
|
datetime
|
||
CancelAtPeriodEnd |
DT_BOOL
|
bit
|
||
CanceledAt |
DT_DBTIMESTAMP
|
datetime
|
||
CollectionMethod |
DT_WSTR
|
nvarchar(200)
|
200 | |
Currency |
DT_WSTR
|
nvarchar(50)
|
50 | |
Created |
DT_DBTIMESTAMP
|
datetime
|
||
CurrentPeriodEnd |
DT_DBTIMESTAMP
|
datetime
|
||
CurrentPeriodStart |
DT_DBTIMESTAMP
|
datetime
|
||
Customer |
DT_WSTR
|
nvarchar(180)
|
180 | |
DaysUntilDue |
DT_WSTR
|
nvarchar(255)
|
255 | |
DefaultPaymentMethod |
DT_WSTR
|
nvarchar(255)
|
255 | |
DefaultSource |
DT_WSTR
|
nvarchar(255)
|
255 | |
DefaultTaxRates |
DT_WSTR
|
nvarchar(20)
|
20 | |
Description |
DT_WSTR
|
nvarchar(255)
|
255 | |
Discount |
DT_WSTR
|
nvarchar(255)
|
255 | |
EndedAt |
DT_DBTIMESTAMP
|
datetime
|
||
ItemsObject |
DT_WSTR
|
nvarchar(40)
|
40 | |
ItemsData |
DT_NTEXT
|
nvarchar(MAX)
|
||
ItemsHasMore |
DT_BOOL
|
bit
|
||
ItemsTotalCount |
DT_I4
|
int
|
||
ItemsUrl |
DT_WSTR
|
nvarchar(540)
|
540 | |
LatestInvoice |
DT_WSTR
|
nvarchar(270)
|
270 | |
LiveMode |
DT_BOOL
|
bit
|
||
NextPendingInvoiceItemInvoice |
DT_WSTR
|
nvarchar(255)
|
255 | |
OnBehalfOf |
DT_WSTR
|
nvarchar(255)
|
255 | |
PauseCollection |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentSettingsPaymentMethodOptions |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentSettingsPaymentMethodTypes |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentSettingsSaveDefaultPaymentMethod |
DT_WSTR
|
nvarchar(255)
|
255 | |
PendingInvoiceItemInterval |
DT_WSTR
|
nvarchar(255)
|
255 | |
PendingSetupIntent |
DT_WSTR
|
nvarchar(255)
|
255 | |
PendingUpdate |
DT_WSTR
|
nvarchar(255)
|
255 | |
PlanId |
DT_WSTR
|
nvarchar(300)
|
300 | |
PlanObject |
DT_WSTR
|
nvarchar(40)
|
40 | |
PlanActive |
DT_BOOL
|
bit
|
||
PlanAggregateUsage |
DT_WSTR
|
nvarchar(30)
|
30 | |
PlanAmount |
DT_I4
|
int
|
||
PlanAmountDecimal |
DT_WSTR
|
nvarchar(30)
|
30 | |
PlanBillingScheme |
DT_WSTR
|
nvarchar(80)
|
80 | |
PlanCreated |
DT_DBTIMESTAMP
|
datetime
|
||
PlanCurrency |
DT_WSTR
|
nvarchar(30)
|
30 | |
PlanInterval |
DT_WSTR
|
nvarchar(50)
|
50 | |
PlanIntervalCount |
DT_I4
|
int
|
||
PlanLiveMode |
DT_BOOL
|
bit
|
||
PlanNickName |
DT_WSTR
|
nvarchar(100)
|
100 | |
PlanProductId |
DT_WSTR
|
nvarchar(190)
|
190 | |
PlanTiersMode |
DT_WSTR
|
nvarchar(255)
|
255 | |
PlanTransformUsage |
DT_WSTR
|
nvarchar(255)
|
255 | |
PlanTrialPeriodDays |
DT_I4
|
int
|
||
PlanUsageType |
DT_WSTR
|
nvarchar(70)
|
70 | |
Quantity |
DT_I4
|
int
|
||
Schedule |
DT_WSTR
|
nvarchar(255)
|
255 | |
StartDate |
DT_DBTIMESTAMP
|
datetime
|
||
Status |
DT_WSTR
|
nvarchar(60)
|
60 | |
TestClock |
DT_WSTR
|
nvarchar(255)
|
255 | |
TransferData |
DT_WSTR
|
nvarchar(255)
|
255 | |
TrialEnd |
DT_DBTIMESTAMP
|
datetime
|
||
TrialStart |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(4000)
|
4000 |
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 Subscriptions table, therefore it is better to use it, instead of accessing the endpoint directly:
Required Parameters | |
---|---|
Subscription Id | Fill-in the parameter... |
Optional Parameters | |
ContineOn404Error | True |

API Destination
This Endpoint belongs to the Subscriptions table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to retrieve a single subscription:
Required Parameters | |
---|---|
Subscription Id | Fill-in the parameter... |
Optional Parameters | |
ContineOn404Error | True |

ODBC application
Use these SQL queries in your ODBC application data source:
Retrieve a single subscription
SELECT * FROM Subscriptions
WHERE Id = 'abcd-1234-id'
get_single_subscription
endpoint belongs to
Subscriptions
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:
Retrieve a single subscription
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Subscriptions
WHERE Id = ''abcd-1234-id''';
EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];
get_single_subscription
endpoint belongs to
Subscriptions
table(s), and can therefore be used via those table(s).