EndPoint Retrieve a single Subscription

Name

get_single_subscription

Description

Returns a single subscription. [API reference]

Parameters

Parameter	Label	Required	Options	Description
Id	Subscription Id	YES		Unique identifier for the Subscription

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(180)`	180	`False`
Object	`DT_WSTR`	`nvarchar(120)`	120	`False`
Application	`DT_WSTR`	`nvarchar(255)`	255	`False`
ApplicationFeePercent	`DT_WSTR`	`nvarchar(255)`	255	`False`
AutomaticTaxEnabled	`DT_BOOL`	`bit`		`False`
BillingCycleAnchor	`DT_DBTIMESTAMP`	`datetime`		`False`
BillingThresholds	`DT_WSTR`	`nvarchar(255)`	255	`False`
CancelAt	`DT_DBTIMESTAMP`	`datetime`		`False`
CancelAtPeriodEnd	`DT_BOOL`	`bit`		`False`
CanceledAt	`DT_DBTIMESTAMP`	`datetime`		`False`
CollectionMethod	`DT_WSTR`	`nvarchar(200)`	200	`False`
Currency	`DT_WSTR`	`nvarchar(50)`	50	`False`
Created	`DT_DBTIMESTAMP`	`datetime`		`False`
CurrentPeriodEnd	`DT_DBTIMESTAMP`	`datetime`		`False`
CurrentPeriodStart	`DT_DBTIMESTAMP`	`datetime`		`False`
Customer	`DT_WSTR`	`nvarchar(180)`	180	`False`
DaysUntilDue	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultPaymentMethod	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultSource	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultTaxRates	`DT_WSTR`	`nvarchar(20)`	20	`False`
Description	`DT_WSTR`	`nvarchar(255)`	255	`False`
Discount	`DT_WSTR`	`nvarchar(255)`	255	`False`
EndedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
ItemsObject	`DT_WSTR`	`nvarchar(40)`	40	`False`
ItemsData	`DT_NTEXT`	`nvarchar(MAX)`		`False`
ItemsHasMore	`DT_BOOL`	`bit`		`False`
ItemsTotalCount	`DT_I4`	`int`		`False`
ItemsUrl	`DT_WSTR`	`nvarchar(540)`	540	`False`
LatestInvoice	`DT_WSTR`	`nvarchar(270)`	270	`False`
LiveMode	`DT_BOOL`	`bit`		`False`
NextPendingInvoiceItemInvoice	`DT_WSTR`	`nvarchar(255)`	255	`False`
OnBehalfOf	`DT_WSTR`	`nvarchar(255)`	255	`False`
PauseCollection	`DT_WSTR`	`nvarchar(255)`	255	`False`
PaymentSettingsPaymentMethodOptions	`DT_WSTR`	`nvarchar(255)`	255	`False`
PaymentSettingsPaymentMethodTypes	`DT_WSTR`	`nvarchar(255)`	255	`False`
PaymentSettingsSaveDefaultPaymentMethod	`DT_WSTR`	`nvarchar(255)`	255	`False`
PendingInvoiceItemInterval	`DT_WSTR`	`nvarchar(255)`	255	`False`
PendingSetupIntent	`DT_WSTR`	`nvarchar(255)`	255	`False`
PendingUpdate	`DT_WSTR`	`nvarchar(255)`	255	`False`
PlanId	`DT_WSTR`	`nvarchar(300)`	300	`False`
PlanObject	`DT_WSTR`	`nvarchar(40)`	40	`False`
PlanActive	`DT_BOOL`	`bit`		`False`
PlanAggregateUsage	`DT_WSTR`	`nvarchar(30)`	30	`False`
PlanAmount	`DT_I4`	`int`		`False`
PlanAmountDecimal	`DT_WSTR`	`nvarchar(30)`	30	`False`
PlanBillingScheme	`DT_WSTR`	`nvarchar(80)`	80	`False`
PlanCreated	`DT_DBTIMESTAMP`	`datetime`		`False`
PlanCurrency	`DT_WSTR`	`nvarchar(30)`	30	`False`
PlanInterval	`DT_WSTR`	`nvarchar(50)`	50	`False`
PlanIntervalCount	`DT_I4`	`int`		`False`
PlanLiveMode	`DT_BOOL`	`bit`		`False`
PlanNickName	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanProductId	`DT_WSTR`	`nvarchar(190)`	190	`False`
PlanTiersMode	`DT_WSTR`	`nvarchar(255)`	255	`False`
PlanTransformUsage	`DT_WSTR`	`nvarchar(255)`	255	`False`
PlanTrialPeriodDays	`DT_I4`	`int`		`False`
PlanUsageType	`DT_WSTR`	`nvarchar(70)`	70	`False`
Quantity	`DT_I4`	`int`		`False`
Schedule	`DT_WSTR`	`nvarchar(255)`	255	`False`
StartDate	`DT_DBTIMESTAMP`	`datetime`		`False`
Status	`DT_WSTR`	`nvarchar(60)`	60	`False`
TestClock	`DT_WSTR`	`nvarchar(255)`	255	`False`
TransferData	`DT_WSTR`	`nvarchar(255)`	255	`False`
TrialEnd	`DT_DBTIMESTAMP`	`datetime`		`False`
TrialStart	`DT_DBTIMESTAMP`	`datetime`		`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

Retrieve a single Subscription using API Source

Stripe

Retrieve a single Subscription

SSIS API Source - Read from table or endpoint

Retrieve a single Subscription using API Destination

Stripe

Retrieve a single Subscription