AppSubscriptionLineItems
Lists the plan components and recurring line items that comprise an app subscription.
Table-Specific Information
Select
The driver uses the Shopify API to process WHERE clause conditions built with the following column and operators. The driver processes other filters client-side within the driver.
- AppInstallationId supports the '=, IN' comparison operators.
For example, the following query is processed server-side:
SELECT * FROM AppSubscriptionLineItems WHERE AppInstallationId = 'Val1'
Update
The following columns can be updated:
UsagePricingPlanCappedAmount, UsagePricingPlanCappedAmountCurrencyCode
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The globally unique identifier of the app subscription line item. | |
| AppSubscriptionId | String | True |
The globally unique identifier of the app subscription that this line item belongs to. | |
| AppInstallationId | String | True |
The globally unique identifier of the app installation linked to this subscription line item. | |
| RecurringPricingPlanDiscountDurationLimitInIntervals | Int | True |
The total number of billing intervals during which the discount is applied. If blank, the discount applies indefinitely. | |
| RecurringPricingPlanDiscountPriceAfterDiscountAmount | Decimal | True |
The subscription price after discounts are applied, expressed as a decimal money amount. | |
| RecurringPricingPlanDiscountPriceAfterDiscountCurrencyCode | String | True |
The currency code for the subscription price after discounts are applied. | |
| RecurringPricingPlanDiscountRemainingDurationInIntervals | Int | True |
The number of billing intervals remaining in which the discount is applied. | |
| RecurringPricingPlanValueAmount | Decimal | True |
The value of the recurring discount applied to each billing interval, expressed as a decimal money amount. | |
| RecurringPricingPlanValueAmountCurrencyCode | String | True |
The currency code for the recurring discount value applied each billing interval. | |
| RecurringPricingPlanValuePercentage | Double | True |
The discount rate applied to each billing interval, expressed as a percentage. | |
| RecurringPricingPlanInterval | String | True |
The frequency at which the merchant is billed for the app subscription, such as monthly or yearly. | |
| RecurringPricingPlanHandle | String | True |
The handle (unique identifier) of the app store pricing plan for the subscription. | |
| RecurringPricingPlanPriceAmount | Decimal | True |
The amount billed to the merchant for the subscription at each interval, expressed as a decimal money amount. | |
| RecurringPricingPlanPriceCurrencyCode | String | True |
The currency code for the recurring subscription price billed to the merchant. | |
| UsagePricingPlanBalanceUsedAmount | Decimal | True |
The total usage charges accumulated during the billing interval, expressed as a decimal money amount. | |
| UsagePricingPlanBalanceUsedCurrencyCode | String | True |
The currency code for the usage charges accumulated during the billing interval. | |
| UsagePricingPlanCappedAmount | Decimal | False |
The capped amount that limits how much a merchant can be billed for usage within a billing period. If usage exceeds this cap, the merchant must approve a new usage charge to continue using the app. Expressed as a decimal money amount. | |
| UsagePricingPlanCappedAmountCurrencyCode | String | False |
The currency code for the capped usage charge amount. | |
| UsagePricingPlanInterval | String | True |
The frequency at which usage charges for the app are billed, such as daily, monthly, or yearly. | |
| UsagePricingPlanTerms | String | True |
The terms and conditions governing app usage pricing. These must be provided to create usage charges and are shown to the merchant when they approve usage billing. |