EndPoint Retrieve a single Subscription
Name
get_single_subscription
Description
Returns a single subscription.
[API Help]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| Id |
Subscription Id |
YES |
|
Unique identifier for the Subscription
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_WSTR |
180 |
False |
|
| Object |
DT_WSTR |
120 |
False |
|
| Application |
DT_WSTR |
255 |
False |
|
| ApplicationFeePercent |
DT_WSTR |
255 |
False |
|
| AutomaticTaxEnabled |
DT_BOOL |
0 |
False |
|
| BillingCycleAnchor |
DT_DBTIMESTAMP |
0 |
False |
|
| BillingThresholds |
DT_WSTR |
255 |
False |
|
| CancelAt |
DT_DBTIMESTAMP |
0 |
False |
|
| CancelAtPeriodEnd |
DT_BOOL |
0 |
False |
|
| CanceledAt |
DT_DBTIMESTAMP |
0 |
False |
|
| CollectionMethod |
DT_WSTR |
200 |
False |
|
| Currency |
DT_WSTR |
50 |
False |
|
| Created |
DT_DBTIMESTAMP |
0 |
False |
|
| CurrentPeriodEnd |
DT_DBTIMESTAMP |
0 |
False |
|
| CurrentPeriodStart |
DT_DBTIMESTAMP |
0 |
False |
|
| Customer |
DT_WSTR |
180 |
False |
|
| DaysUntilDue |
DT_WSTR |
255 |
False |
|
| DefaultPaymentMethod |
DT_WSTR |
255 |
False |
|
| DefaultSource |
DT_WSTR |
255 |
False |
|
| DefaultTaxRates |
DT_WSTR |
20 |
False |
|
| Description |
DT_WSTR |
255 |
False |
|
| Discount |
DT_WSTR |
255 |
False |
|
| EndedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| ItemsObject |
DT_WSTR |
40 |
False |
|
| ItemsData |
DT_NTEXT |
0 |
False |
|
| ItemsHasMore |
DT_BOOL |
0 |
False |
|
| ItemsTotalCount |
DT_I4 |
0 |
False |
|
| ItemsUrl |
DT_WSTR |
540 |
False |
|
| LatestInvoice |
DT_WSTR |
270 |
False |
|
| LiveMode |
DT_BOOL |
0 |
False |
|
| NextPendingInvoiceItemInvoice |
DT_WSTR |
255 |
False |
|
| OnBehalfOf |
DT_WSTR |
255 |
False |
|
| PauseCollection |
DT_WSTR |
255 |
False |
|
| PaymentSettingsPaymentMethodOptions |
DT_WSTR |
255 |
False |
|
| PaymentSettingsPaymentMethodTypes |
DT_WSTR |
255 |
False |
|
| PaymentSettingsSaveDefaultPaymentMethod |
DT_WSTR |
255 |
False |
|
| PendingInvoiceItemInterval |
DT_WSTR |
255 |
False |
|
| PendingSetupIntent |
DT_WSTR |
255 |
False |
|
| PendingUpdate |
DT_WSTR |
255 |
False |
|
| PlanId |
DT_WSTR |
300 |
False |
|
| PlanObject |
DT_WSTR |
40 |
False |
|
| PlanActive |
DT_BOOL |
0 |
False |
|
| PlanAggregateUsage |
DT_WSTR |
30 |
False |
|
| PlanAmount |
DT_I4 |
0 |
False |
|
| PlanAmountDecimal |
DT_WSTR |
30 |
False |
|
| PlanBillingScheme |
DT_WSTR |
80 |
False |
|
| PlanCreated |
DT_DBTIMESTAMP |
0 |
False |
|
| PlanCurrency |
DT_WSTR |
30 |
False |
|
| PlanInterval |
DT_WSTR |
50 |
False |
|
| PlanIntervalCount |
DT_I4 |
0 |
False |
|
| PlanLiveMode |
DT_BOOL |
0 |
False |
|
| PlanNickName |
DT_WSTR |
100 |
False |
|
| PlanProductId |
DT_WSTR |
190 |
False |
|
| PlanTiersMode |
DT_WSTR |
255 |
False |
|
| PlanTransformUsage |
DT_WSTR |
255 |
False |
|
| PlanTrialPeriodDays |
DT_I4 |
0 |
False |
|
| PlanUsageType |
DT_WSTR |
70 |
False |
|
| Quantity |
DT_I4 |
0 |
False |
|
| Schedule |
DT_WSTR |
255 |
False |
|
| StartDate |
DT_DBTIMESTAMP |
0 |
False |
|
| Status |
DT_WSTR |
60 |
False |
|
| TestClock |
DT_WSTR |
255 |
False |
|
| TransferData |
DT_WSTR |
255 |
False |
|
| TrialEnd |
DT_DBTIMESTAMP |
0 |
False |
|
| TrialStart |
DT_DBTIMESTAMP |
0 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_WSTR |
4000 |
False |
|
