AppSubscriptions
Lists all subscriptions created for a shop on the installed application.
Table-Specific Information
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following column and operators. The connector processes other filters client-side within the connector.
- AppInstallationId supports the '=, IN' comparison operators.
For example, the following query is processed server-side:
SELECT * FROM AppSubscriptions WHERE AppInstallationId = 'Val1'
Insert
The following columns can be used to create a new record:
Name, Test, ReturnUrl, TrialDays, LineItem (references AppSubscriptionLineItems)
AppSubscriptionLineItems Temporary Table Columns
| Column Name | Type | Description |
| RecurringPricingPlanDiscountPriceAfterDiscountAmount | Decimal | The price of the subscription after the discount is applied. Decimal money amount. |
| RecurringPricingPlanDiscountRemainingDurationInIntervals | Int | The remaining number of billing intervals to which the discount will be applied. |
| RecurringPricingPlanValuePercentage | Double | The value of the discount applied every billing interval. The percentage value of a discount. |
| RecurringPricingPlanInterval | String | The frequency at which the subscribing shop is billed for an app subscription. |
| RecurringPricingPlanPriceAmount | Decimal | The amount to be charged to the subscribing shop every billing interval. Decimal money amount. |
| RecurringPricingPlanPriceCurrencyCode | String | The currency to be charged to the subscribing shop every billing interval. Currency of the money. |
| UsagePricingPlanCappedAmount | Decimal | The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Decimal money amount. |
| UsagePricingPlanCappedAmountCurrencyCode | String | The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Currency of the money. |
| UsagePricingPlanTerms | String | The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges. |
Delete
You can delete entries by specifying the following column:
Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| AppInstallationId | String | True |
A globally-unique ID. | |
| Name | String | True |
The name of the app subscription. | |
| Status | String | True |
The status of the app subscription. | |
| Test | Bool | True |
Specifies whether the app subscription is a test transaction. | |
| ReturnUrl | String | True |
The URL that the merchant is redirected to after approving the app subscription. | |
| TrialDays | Int | True |
The number of free trial days, starting at the subscription's creation date, by which billing is delayed. | |
| CurrentPeriodEnd | Datetime | True |
The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active. | |
| CreatedAt | Datetime | True |
The date and time when the app subscription was created. | |
| LineItemIds | String | True |
The IDs of the plans attached to the app subscription. | |
| LineItem | String | True |
The plans attached to the app subscription. |