SellingPlanGroups
Defines selling plan groups that bundle multiple subscription or payment plan options for products.
Table-Specific Information
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.
- Id supports the '=, IN' comparison operators.
- Name supports the '=' comparison operator.
- CreatedAt supports the '<, >, >=' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM SellingPlanGroups WHERE Id = 'Val1'
SELECT * FROM SellingPlanGroups WHERE Name = 'Val1'
SELECT * FROM SellingPlanGroups WHERE CreatedAt < '2023-01-01 11:10:00'
Insert
The following columns can be used to create a new record:
AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate (references SellingPlanGroupSellingPlans)
The following pseudo-columns can be used to create a new record:
ProductIds, ProductVariantIds
SellingPlanGroupSellingPlans Temporary Table Columns
| Column Name | Type | Description |
| Id | String | A globally-unique ID. |
| Name | String | A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies. |
| Category | String | The category used to classify the selling plan for reporting purposes. |
| Description | String | Buyer facing string which describes the selling plan commitment. |
| Options | String | The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. |
| Position | Int | Relative position of the selling plan for display. A lower position will be displayed before a higher position. |
| InventoryPolicyReserve | String | When to reserve inventory for the order. |
| FixedBillingPolicyCheckoutChargeType | String | The charge type for the checkout charge. |
| FixedBillingPolicyCheckoutChargeValueAmount | Decimal | The charge value for the checkout charge. Decimal money amount. |
| FixedBillingPolicyCheckoutChargeValuePercentage | Double | The charge value for the checkout charge. The percentage value of the price used for checkout charge. |
| FixedBillingPolicyRemainingBalanceChargeExactTime | Datetime | The exact time when to capture the full payment. |
| FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout | String | The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. |
| FixedBillingPolicyRemainingBalanceChargeTrigger | String | When to capture payment for amount due. |
| RecurringBillingPolicyAnchors | String | Specific anchor dates upon which the billing interval calculations should be made. Aggregate value. |
| RecurringBillingPolicyInterval | String | The billing frequency, it can be either: day, week, month or year. |
| RecurringBillingPolicyIntervalCount | Int | The number of intervals between billings. |
| RecurringBillingPolicyMaxCycles | Int | Maximum number of billing iterations. |
| RecurringBillingPolicyMinCycles | Int | Minimum number of billing iterations. |
| FixedDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. |
| FixedDeliveryPolicyCutoff | Int | A buffer period for orders to be included in next fulfillment anchor. |
| FixedDeliveryPolicyFulfillmentExactTime | Datetime | The date and time when the fulfillment should trigger. |
| FixedDeliveryPolicyFulfillmentTrigger | String | What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. |
| FixedDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. |
| FixedDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. |
| RecurringDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. |
| RecurringDeliveryPolicyCutoff | Int | Number of days which represent a buffer period for orders to be included in a cycle. |
| RecurringDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. |
| RecurringDeliveryPolicyInterval | String | The delivery frequency, it can be either: day, week, month or year. |
| RecurringDeliveryPolicyIntervalCount | Int | The number of intervals between deliveries. |
| RecurringDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. |
| FixedPricingPolicies | String | Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value. |
| RecurringPricingPolicies | String | Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value. |
| Metafields (references Metafields) | String | Attaches additional metadata to a store's resources. |
Metafields Temporary Table Columns
| Column Name | Type | Description |
| Id | String | The unique ID of the metafield. |
| Namespace | String | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. |
| Key | String | The name of the metafield. |
| Value | String | The information to be stored as metadata. |
| Type | String | The metafield's information type. |
Update
The following columns can be updated:
AppId, Name, Description, Options, Position, MerchantCode, SellingPlansToCreate (references SellingPlanGroupSellingPlans), SellingPlansToUpdate (references SellingPlanGroupSellingPlans)
The following pseudo-column can be used to update a record:
SellingPlansToDelete
SellingPlanGroupSellingPlans Temporary Table Columns
| Column Name | Type | Description |
| Id | String | A globally-unique ID. |
| Name | String | A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies. |
| Category | String | The category used to classify the selling plan for reporting purposes. |
| Description | String | Buyer facing string which describes the selling plan commitment. |
| Options | String | The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values. |
| Position | Int | Relative position of the selling plan for display. A lower position will be displayed before a higher position. |
| InventoryPolicyReserve | String | When to reserve inventory for the order. |
| FixedBillingPolicyCheckoutChargeType | String | The charge type for the checkout charge. |
| FixedBillingPolicyCheckoutChargeValueAmount | Decimal | The charge value for the checkout charge. Decimal money amount. |
| FixedBillingPolicyCheckoutChargeValuePercentage | Double | The charge value for the checkout charge. The percentage value of the price used for checkout charge. |
| FixedBillingPolicyRemainingBalanceChargeExactTime | Datetime | The exact time when to capture the full payment. |
| FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout | String | The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. |
| FixedBillingPolicyRemainingBalanceChargeTrigger | String | When to capture payment for amount due. |
| RecurringBillingPolicyAnchors | String | Specific anchor dates upon which the billing interval calculations should be made. Aggregate value. |
| RecurringBillingPolicyInterval | String | The billing frequency, it can be either: day, week, month or year. |
| RecurringBillingPolicyIntervalCount | Int | The number of intervals between billings. |
| RecurringBillingPolicyMaxCycles | Int | Maximum number of billing iterations. |
| RecurringBillingPolicyMinCycles | Int | Minimum number of billing iterations. |
| FixedDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. |
| FixedDeliveryPolicyCutoff | Int | A buffer period for orders to be included in next fulfillment anchor. |
| FixedDeliveryPolicyFulfillmentExactTime | Datetime | The date and time when the fulfillment should trigger. |
| FixedDeliveryPolicyFulfillmentTrigger | String | What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. |
| FixedDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. |
| FixedDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. |
| RecurringDeliveryPolicyAnchors | String | The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value. |
| RecurringDeliveryPolicyCutoff | Int | Number of days which represent a buffer period for orders to be included in a cycle. |
| RecurringDeliveryPolicyIntent | String | Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported. |
| RecurringDeliveryPolicyInterval | String | The delivery frequency, it can be either: day, week, month or year. |
| RecurringDeliveryPolicyIntervalCount | Int | The number of intervals between deliveries. |
| RecurringDeliveryPolicyPreAnchorBehavior | String | The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP. |
| FixedPricingPolicies | String | Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value. |
| RecurringPricingPolicies | String | Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value. |
| Metafields (references Metafields) | String | Attaches additional metadata to a store's resources. |
Metafields Temporary Table Columns
| Column Name | Type | Description |
| Id | String | The unique ID of the metafield. |
| Namespace | String | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. |
| Key | String | The name of the metafield. |
| Value | String | The information to be stored as metadata. |
| Type | String | The metafield's information type. |
Delete
You can delete entries by specifying the following column:
Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally unique identifier for the selling plan group. | |
| AppId | String | False |
The identifier of the app that created the selling plan group, exposed in Liquid templates and product JSON for reference in custom storefronts. | |
| Name | String | False |
The buyer-facing title of the selling plan group, shown to customers when selecting subscription or recurring purchase options. | |
| Description | String | False |
The merchant-facing explanation of the selling plan group, describing its purpose or configuration in the admin interface. | |
| Options | String | False |
Lists all option values available within the selling plan group. Selling plans are grouped when they share the same originating app, buyer-facing name, and available option values. | |
| Position | Int | False |
The display order or ranking of the selling plan group, determining how it appears in product or checkout interfaces. | |
| Summary | String | True |
A short overview of the key policies, such as billing frequency or delivery schedule, associated with the selling plan group. | |
| MerchantCode | String | False |
The internal or merchant-facing code used to identify the selling plan group in reports or integrations. | |
| ProductsCount | Int | True |
The number of products currently linked to the selling plan group. | |
| ProductsCountPrecision | String | True |
Indicates the precision of the product count, describing whether the value is exact or estimated. | |
| CreatedAt | Datetime | True |
The date and time when the selling plan group was initially created. | |
| SellingPlansToCreate | String | False |
A list of selling plans that should be created under this group. | |
| SellingPlansToUpdate | String | False |
A list of selling plans within the group that need to be updated. |
Pseudo-Columns
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| SellingPlansToDelete | String |
A comma-separated list of selling plans that should be deleted from the group. |
| ProductIds | String |
A comma-separated list of product IDs to be associated with the selling plan group. |
| ProductVariantIds | String |
A comma-separated list of product variant IDs to be associated with the selling plan group. |