# Appstle

## Docs

- [Get paginated past or upcoming orders report](https://developers.appstle.com/api-reference/billing-&-orders/get-paginated-past-or-upcoming-orders-report.md): Retrieves a paginated list of subscription billing attempts filtered by status (SUCCESS, FAILURE, QUEUED, SKIPPED) with optional contract filtering.
- [Get past orders](https://developers.appstle.com/api-reference/billing-&-orders/get-past-orders.md): Retrieves past order history for a subscription contract from the customer portal.
- [Get upcoming orders](https://developers.appstle.com/api-reference/billing-&-orders/get-upcoming-orders.md): Retrieves upcoming/scheduled orders for a subscription contract from the customer portal.
- [Retry billing for failed attempt](https://developers.appstle.com/api-reference/billing-&-orders/retry-billing-for-failed-attempt.md): Immediately triggers a billing attempt for a subscription contract, bypassing the normal scheduled billing time. This endpoint processes the billing asynchronously via Shopify's Subscription Billing API, creating an order and charging the customer's payment method.
- [Skip an upcoming billing order](https://developers.appstle.com/api-reference/billing-&-orders/skip-an-upcoming-billing-order.md): Skips the next scheduled billing/order for a membership contract. The membership remains active, but the next billing date is moved to the following cycle.
- [Skip upcoming subscription order](https://developers.appstle.com/api-reference/billing-&-orders/skip-upcoming-subscription-order.md): Skips a scheduled billing attempt, preventing the order from being processed. The next billing date is automatically recalculated based on the subscription frequency.
- [Trigger billing attempt](https://developers.appstle.com/api-reference/billing-&-orders/trigger-billing-attempt.md): Triggers an immediate billing attempt for a specific subscription billing record from the customer portal.
- [Update billing attempt](https://developers.appstle.com/api-reference/billing-&-orders/update-billing-attempt.md): Updates a subscription billing attempt record from the customer portal.
- [Update order note for billing attempt](https://developers.appstle.com/api-reference/billing-&-orders/update-order-note-for-billing-attempt.md): Updates the order note/instructions for a specific upcoming billing attempt. These notes are stored with the billing attempt and will appear on the Shopify order when it's created. Order notes are visible to merchants in Shopify admin and can be printed on packing slips.
- [Update subscription billing attempt](https://developers.appstle.com/api-reference/billing-&-orders/update-subscription-billing-attempt.md): Updates billing attempt details for a subscription contract. Billing attempts represent individual charge attempts for recurring subscription orders.
- [Calculate refund amount preview](https://developers.appstle.com/api-reference/billing-&-payments/calculate-refund-amount-preview.md): Calculates the refund amount that would be issued if a specific subscription order fulfillment were refunded. This provides a preview without actually processing the refund.
- [Get past orders](https://developers.appstle.com/api-reference/billing-&-payments/get-past-orders.md): Retrieves paginated list of past (processed) billing attempts for a subscription contract or customer. Includes successful orders, failed attempts, and skipped orders.
- [Get past orders report with detailed filtering](https://developers.appstle.com/api-reference/billing-&-payments/get-past-orders-report-with-detailed-filtering.md): Retrieves a detailed report of past billing attempts with advanced filtering options. This endpoint provides comprehensive data for analytics, troubleshooting, and reporting purposes.
- [Get subscription payment info for a contract](https://developers.appstle.com/api-reference/billing-&-payments/get-subscription-payment-info-for-a-contract.md)
- [Get upcoming orders (top orders)](https://developers.appstle.com/api-reference/billing-&-payments/get-upcoming-orders-top-orders.md): Retrieves upcoming (queued) billing attempts for a subscription contract or customer. Returns the next scheduled orders that have not yet been processed.
- [Get URL for 3DS / SCA security challenge](https://developers.appstle.com/api-reference/billing-&-payments/get-url-for-3ds-sca-security-challenge.md)
- [Process refund for subscription order](https://developers.appstle.com/api-reference/billing-&-payments/process-refund-for-subscription-order.md): Processes a refund for a fulfilled subscription order. This creates a refund in Shopify and returns the money to the customer's original payment method.
- [Recover a billing attempt stuck in progress](https://developers.appstle.com/api-reference/billing-&-payments/recover-a-billing-attempt-stuck-in-progress.md)
- [Reschedule a billing attempt to a new date](https://developers.appstle.com/api-reference/billing-&-payments/reschedule-a-billing-attempt-to-a-new-date.md): Changes the scheduled billing date for a billing attempt. This allows customers to adjust when their next order will be processed.
- [Retry a failed billing attempt](https://developers.appstle.com/api-reference/billing-&-payments/retry-a-failed-billing-attempt.md)
- [Skip a failed billing attempt's order](https://developers.appstle.com/api-reference/billing-&-payments/skip-a-failed-billing-attempts-order.md)
- [Skip a specific order](https://developers.appstle.com/api-reference/billing-&-payments/skip-a-specific-order.md): Skips a specific billing attempt by ID. The order will not be processed on its scheduled date. This is useful when customers want to skip a particular delivery without canceling their subscription.
- [Skip the next upcoming order for a subscription](https://developers.appstle.com/api-reference/billing-&-payments/skip-the-next-upcoming-order-for-a-subscription.md): Skips the next scheduled billing attempt for a subscription contract without requiring the billing attempt ID. Automatically finds and skips the earliest QUEUED billing attempt.
- [Trigger immediate billing for an order](https://developers.appstle.com/api-reference/billing-&-payments/trigger-immediate-billing-for-an-order.md): Immediately processes a billing attempt, creating an order in Shopify. This bypasses the scheduled billing date and processes the order right away.
- [Unskip a previously skipped order](https://developers.appstle.com/api-reference/billing-&-payments/unskip-a-previously-skipped-order.md): Reverses a skip action on a billing attempt. The order will be restored to QUEUED status and will be processed on its scheduled date.
- [Update order note for a billing attempt](https://developers.appstle.com/api-reference/billing-&-payments/update-order-note-for-a-billing-attempt.md): Updates the order note (customer note) for a billing attempt. This note will be included when the order is created in Shopify.
- [Update subscription billing attempt](https://developers.appstle.com/api-reference/billing-&-payments/update-subscription-billing-attempt.md): Updates an existing subscription billing attempt. This endpoint allows modification of billing attempt details such as billing date, order note, and other attributes.
- [Create a new Build-A-Box subscription bundle](https://developers.appstle.com/api-reference/build-a-box-&-bundles/create-a-new-build-a-box-subscription-bundle.md): Creates a new subscription bundle (Build-A-Box) allowing customers to select and customize products for recurring deliveries. Build-A-Box enables a flexible subscription model where customers can create personalized product boxes.
- [Delete a Build-A-Box subscription bundle](https://developers.appstle.com/api-reference/build-a-box-&-bundles/delete-a-build-a-box-subscription-bundle.md): Permanently removes a Build-A-Box subscription bundle from your shop. This operation is irreversible and will prevent new customers from subscribing to this bundle. However, existing subscriptions using this bundle will remain active.
- [Generate discount code for bundle](https://developers.appstle.com/api-reference/build-a-box-&-bundles/generate-discount-code-for-bundle.md): Generates a discount code for a subscription bundle. This endpoint creates a Shopify discount code that can be applied to bundle subscriptions, typically used during the checkout process.
- [Get a subscription bundling configuration by token](https://developers.appstle.com/api-reference/build-a-box-&-bundles/get-a-subscription-bundling-configuration-by-token.md)
- [Get bundle details by handle](https://developers.appstle.com/api-reference/build-a-box-&-bundles/get-bundle-details-by-handle.md): Retrieves complete details for a subscription bundle using its unique handle. This endpoint returns the bundle configuration, included products, pricing, and available subscription options.
- [Get public Build-a-Box bundle details by handle (v3)](https://developers.appstle.com/api-reference/build-a-box-&-bundles/get-public-build-a-box-bundle-details-by-handle-v3.md)
- [Get subscription bundle settings (Build-a-Box configuration)](https://developers.appstle.com/api-reference/build-a-box-&-bundles/get-subscription-bundle-settings-build-a-box-configuration.md): Retrieves the configuration settings for subscription bundles (also known as Build-a-Box or customizable subscription boxes). This endpoint returns all settings that control how customers can create and manage their custom subscription bundles.
- [Get subscription bundle settings by ID](https://developers.appstle.com/api-reference/build-a-box-&-bundles/get-subscription-bundle-settings-by-id.md)
- [List single-product Build-a-Box bundlings for the shop](https://developers.appstle.com/api-reference/build-a-box-&-bundles/list-single-product-build-a-box-bundlings-for-the-shop.md)
- [Retrieve a Build-A-Box bundle by ID](https://developers.appstle.com/api-reference/build-a-box-&-bundles/retrieve-a-build-a-box-bundle-by-id.md): Fetches the complete configuration and details of a specific Build-A-Box subscription bundle using its unique identifier. This endpoint returns all bundle settings including products, pricing, rules, and delivery options.
- [Retrieve Build-A-Box bundle details by handle for customer storefront](https://developers.appstle.com/api-reference/build-a-box-&-bundles/retrieve-build-a-box-bundle-details-by-handle-for-customer-storefront.md): Fetches comprehensive Build-A-Box bundle configuration using a user-friendly handle (URL slug) instead of numeric ID. This endpoint is specifically designed for customer-facing storefronts and integration scenarios where you want to reference bundles by their human-readable handles rather than datab…
- [Update an existing Build-A-Box subscription bundle](https://developers.appstle.com/api-reference/build-a-box-&-bundles/update-an-existing-build-a-box-subscription-bundle.md): Updates an existing Build-A-Box subscription bundle with new configuration settings, product selections, pricing rules, or other bundle attributes. This endpoint allows you to modify any aspect of a previously created bundle while maintaining its unique identifier and shop association.
- [Update subscription bundling configuration](https://developers.appstle.com/api-reference/build-a-box-&-bundles/update-subscription-bundling-configuration.md): Updates the configuration for one or more subscription bundles (Build-a-Box). This endpoint allows bulk updates to bundle product selections, quantities, and configurations.
- [Get bundle settings](https://developers.appstle.com/api-reference/bundle-settings/get-bundle-settings.md): Retrieves the subscription bundle configuration settings for the authenticated shop. Returns settings that control bundle behavior, pricing, and display options.
- [Get cancellation flow configuration](https://developers.appstle.com/api-reference/cancellation-flow-configuration/get-cancellation-flow-configuration.md): Retrieves the cancellation management settings for the shop, controlling how members cancel subscriptions. These settings define the cancellation experience including retention offers, surveys, and confirmation flows.
- [Get cancellation flow settings](https://developers.appstle.com/api-reference/cancellation-flow-configuration/get-cancellation-flow-settings.md): Retrieves the cancellation management configuration including retention offers, cancellation reasons, and survey settings.
- [Get custom CSS styles](https://developers.appstle.com/api-reference/custom-css-styling/get-custom-css-styles.md): Retrieves the custom CSS styling configuration for the subscription customer portal and widgets.
- [Get custom CSS styling configuration](https://developers.appstle.com/api-reference/custom-css-styling/get-custom-css-styling-configuration.md): Retrieves custom CSS styles configured for subscription widgets and customer portal. These styles allow merchants to customize the visual appearance of subscription elements to match their brand.
- [Get past discount codes for contract](https://developers.appstle.com/api-reference/customer-discount-history/get-past-discount-codes-for-contract.md): Retrieves historical discount codes that have been applied to or are associated with a specific membership contract. Returns discount details including code, value, usage limits, and expiration dates from Shopify.
- [Get past discount history](https://developers.appstle.com/api-reference/customer-discount-history/get-past-discount-history.md): Retrieves the history of discount codes applied to a customer's subscription contracts.
- [Enable loyalty program for customer](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/enable-loyalty-program-for-customer.md)
- [Enroll customer in loyalty program](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/enroll-customer-in-loyalty-program.md)
- [Get customer loyalty details](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/get-customer-loyalty-details.md)
- [Get customer loyalty information](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/get-customer-loyalty-information.md)
- [Get logged-in customer ID](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/get-logged-in-customer-id.md)
- [Sync customer metafield data](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/sync-customer-metafield-data.md)
- [Update customer birth date](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/update-customer-birth-date.md)
- [Update customer loyalty status](https://developers.appstle.com/api-reference/customer-enrollment-&-profile/update-customer-loyalty-status.md)
- [Get customer payment token information](https://developers.appstle.com/api-reference/customer-payment-methods/get-customer-payment-token-information.md): Retrieves payment method token information for a specific customer. This endpoint returns the customer's stored payment tokens used for recurring subscription billing.
- [Get customer portal label translations for locale](https://developers.appstle.com/api-reference/customer-portal-configuration/get-customer-portal-label-translations-for-locale.md)
- [Get customer portal settings](https://developers.appstle.com/api-reference/customer-portal-configuration/get-customer-portal-settings.md): Retrieves the customer portal configuration including UI customization, text labels, feature toggles, and branding options.
- [Check Customer Account API authentication status](https://developers.appstle.com/api-reference/customer-portal/check-customer-account-api-authentication-status.md): Checks whether the current customer has valid Customer Account API tokens stored. Used by the customer portal to determine if the customer needs to authenticate.
- [Get shop info for the currently signed-in shop](https://developers.appstle.com/api-reference/customer-portal/get-shop-info-for-the-currently-signed-in-shop.md)
- [Handle OAuth callback from Shopify](https://developers.appstle.com/api-reference/customer-portal/handle-oauth-callback-from-shopify.md): OAuth 2.0 callback endpoint that receives the authorization code from Shopify after customer authorization. This endpoint is called automatically by Shopify after the customer authorizes the app.
- [Initiate Customer Account API OAuth flow](https://developers.appstle.com/api-reference/customer-portal/initiate-customer-account-api-oauth-flow.md): Initiates the OAuth 2.0 authorization flow for Shopify's Customer Account API. This endpoint is used when a customer wants to grant the subscription app access to their Shopify customer account data.
- [Logout from Customer Account API](https://developers.appstle.com/api-reference/customer-portal/logout-from-customer-account-api.md): Logs out the customer from the Customer Account API session. This can be initiated either by the customer clicking logout in the customer portal, or by Shopify's end session callback.
- [Proxy GraphQL queries to Shopify Customer Account API](https://developers.appstle.com/api-reference/customer-portal/proxy-graphql-queries-to-shopify-customer-account-api.md): Executes GraphQL queries against Shopify's Customer Account API on behalf of the authenticated customer. This endpoint handles token management, refresh, and authentication automatically.
- [Create retention activity record](https://developers.appstle.com/api-reference/customer-retention/create-retention-activity-record.md): Records a customer retention activity such as cancellation feedback, retention offer acceptance, or other retention-related actions.
- [Get cancellation management configuration](https://developers.appstle.com/api-reference/customer-retention/get-cancellation-management-configuration.md)
- [Record a customer retention activity](https://developers.appstle.com/api-reference/customer-retention/record-a-customer-retention-activity.md)
- [Generate customer portal access link by customer ID or email](https://developers.appstle.com/api-reference/customers/generate-customer-portal-access-link-by-customer-id-or-email.md): Generates a secure, time-limited magic link that allows customers to access their subscription management portal. This endpoint supports lookup by either customer ID or email address, making it flexible for different integration scenarios.
- [Generate customer portal link](https://developers.appstle.com/api-reference/customers/generate-customer-portal-link.md): Generates a secure, time-limited link that allows customers to access their subscription management portal. This link provides customers with self-service capabilities to manage their subscriptions without requiring login credentials.
- [Get customer details with subscriptions](https://developers.appstle.com/api-reference/customers/get-customer-details-with-subscriptions.md): Retrieves comprehensive customer information including their subscription contracts. This endpoint provides customer profile data along with a paginated list of their active and historical subscriptions.
- [Get customer payment methods from Shopify](https://developers.appstle.com/api-reference/customers/get-customer-payment-methods-from-shopify.md): Retrieves all payment methods associated with a customer directly from Shopify's payment API. This endpoint returns detailed information about stored payment instruments including credit/debit cards, digital wallets, and other payment methods that the customer can use for subscription billing.
- [Get detailed subscription information for a customer](https://developers.appstle.com/api-reference/customers/get-detailed-subscription-information-for-a-customer.md): Retrieves comprehensive subscription contract details for a specific customer, including subscription status, products, billing information, delivery schedules, and more. This endpoint returns full subscription objects with all associated data, making it ideal for displaying subscription management…
- [Get valid subscription contract IDs for a customer](https://developers.appstle.com/api-reference/customers/get-valid-subscription-contract-ids-for-a-customer.md): Retrieves a set of all valid (active, paused, or otherwise non-deleted) subscription contract IDs for a specific customer. This endpoint returns only the contract IDs without detailed subscription information, making it ideal for quick lookups and validation checks.
- [Retrieve customers with subscriptions](https://developers.appstle.com/api-reference/customers/retrieve-customers-with-subscriptions.md): Returns a paginated list of customers who have subscription contracts. Supports filtering by customer name, email, and subscription count.
- [Sync customer subscription details from Shopify](https://developers.appstle.com/api-reference/customers/sync-customer-subscription-details-from-shopify.md): Synchronizes customer subscription information from Shopify to the Appstle subscription system. This endpoint fetches the latest customer data from Shopify and updates the local database to ensure data consistency across platforms.
- [Get custom CSS for customer portal](https://developers.appstle.com/api-reference/customization/get-custom-css-for-customer-portal.md): Retrieves the custom CSS styling configuration for the customer portal. This endpoint returns all custom CSS rules that have been configured to customize the appearance, layout, and branding of the subscription customer portal.
- [Get customer portal label translations for locale](https://developers.appstle.com/api-reference/customization/get-customer-portal-label-translations-for-locale.md)
- [Get customer portal settings](https://developers.appstle.com/api-reference/customization/get-customer-portal-settings.md): Retrieves the customer portal configuration and settings for the authenticated shop. The customer portal is the self-service interface where subscribers can manage their subscriptions, update payment methods, modify delivery addresses, and more.
- [Get shop customization CSS by category](https://developers.appstle.com/api-reference/customization/get-shop-customization-css-by-category.md)
- [Regenerate subscription widget scripts](https://developers.appstle.com/api-reference/customization/regenerate-subscription-widget-scripts.md): Triggers regeneration and deployment of subscription widget JavaScript files for the authenticated shop. This endpoint rebuilds the widget scripts that power subscription functionality on your storefront and deploys them to CDN.
- [Get the live fulfillment status for an order](https://developers.appstle.com/api-reference/delivery-&-shipping/get-the-live-fulfillment-status-for-an-order.md)
- [List delivery profile locations](https://developers.appstle.com/api-reference/delivery-&-shipping/list-delivery-profile-locations.md)
- [Get available loyalty point redemption options](https://developers.appstle.com/api-reference/loyalty-integration/get-available-loyalty-point-redemption-options.md): Returns all available rewards that the customer can redeem their loyalty points for. This shows customers what they can spend their points on.
- [Get available ways to earn loyalty points](https://developers.appstle.com/api-reference/loyalty-integration/get-available-ways-to-earn-loyalty-points.md): Returns all active point earning campaigns and rules that the customer can participate in. This shows customers how they can earn more points.
- [Get customer loyalty points and rewards data](https://developers.appstle.com/api-reference/loyalty-integration/get-customer-loyalty-points-and-rewards-data.md): Retrieves the loyalty/rewards program data for the currently logged-in customer. This includes points balance, tier status, and available rewards.
- [Get loyalty customer details](https://developers.appstle.com/api-reference/loyalty-integration/get-loyalty-customer-details.md): Retrieves loyalty program details for a customer associated with a specific subscription contract, including points balance.
- [Get loyalty point earn options](https://developers.appstle.com/api-reference/loyalty-integration/get-loyalty-point-earn-options.md): Retrieves available loyalty point earning campaigns and rules for the shop.
- [Get loyalty point redeem options](https://developers.appstle.com/api-reference/loyalty-integration/get-loyalty-point-redeem-options.md): Retrieves available loyalty point redemption rules and options for the shop.
- [Redeem loyalty points](https://developers.appstle.com/api-reference/loyalty-integration/redeem-loyalty-points.md): Redeems loyalty points for a customer associated with a specific subscription contract using the specified redemption option.
- [Redeem loyalty points for a reward](https://developers.appstle.com/api-reference/loyalty-integration/redeem-loyalty-points-for-a-reward.md): Allows a customer to redeem their loyalty points for a specific reward option. This deducts points from their balance and generates a discount code or applies the reward.
- [Add a product to an existing membership contract](https://developers.appstle.com/api-reference/membership-contracts/add-a-product-to-an-existing-membership-contract.md): Adds a new product/variant line item to an existing active membership contract. This allows customers or merchants to add additional products to their recurring membership orders.
- [Add line item to contract](https://developers.appstle.com/api-reference/membership-contracts/add-line-item-to-contract.md): Adds a new product line item to a subscription contract from the customer portal.
- [Add product line item to subscription contract](https://developers.appstle.com/api-reference/membership-contracts/add-product-line-item-to-subscription-contract.md): Adds a new product (line item) to an existing subscription contract. This allows customers or merchants to add products to their recurring subscription orders.
- [Add product to recurring subscription](https://developers.appstle.com/api-reference/membership-contracts/add-product-to-recurring-subscription.md): Adds a new product variant to a subscription contract's recurring line items. The product will be included in all future recurring orders.
- [Apply cancellation retention discount](https://developers.appstle.com/api-reference/membership-contracts/apply-cancellation-retention-discount.md): Applies a retention discount to a subscription contract as part of the cancellation flow to retain the customer.
- [Apply discount code](https://developers.appstle.com/api-reference/membership-contracts/apply-discount-code.md): Applies a discount code to a subscription contract from the customer portal.
- [Apply discount code to subscription](https://developers.appstle.com/api-reference/membership-contracts/apply-discount-code-to-subscription.md): Applies an existing Shopify discount code to a subscription contract. The discount code must already exist in Shopify and be valid for subscription usage.
- [Cancel a membership contract](https://developers.appstle.com/api-reference/membership-contracts/cancel-a-membership-contract.md): Permanently cancels an active membership contract in Shopify. This operation stops all future billing and marks the membership as CANCELLED.
- [Cancel membership/subscription contract](https://developers.appstle.com/api-reference/membership-contracts/cancel-membershipsubscription-contract.md): Cancels a membership/subscription contract and sends cancellation confirmation emails. This endpoint terminates the recurring subscription and processes all cancellation workflows.
- [Cancel pending downgrade](https://developers.appstle.com/api-reference/membership-contracts/cancel-pending-downgrade.md): Cancels a pending plan downgrade for a subscription contract.
- [Cancel pending downgrade for a subscription contract](https://developers.appstle.com/api-reference/membership-contracts/cancel-pending-downgrade-for-a-subscription-contract.md): Cancels a scheduled/pending downgrade for a specific subscription contract. This endpoint removes the pending downgrade so that the subscription will continue with its current plan.
- [Create and add custom discount to subscription](https://developers.appstle.com/api-reference/membership-contracts/create-and-add-custom-discount-to-subscription.md): Creates a custom discount and applies it to a subscription contract. This endpoint allows you to create on-the-fly discounts without requiring pre-existing discount codes in Shopify.
- [Generate customer portal authentication token](https://developers.appstle.com/api-reference/membership-contracts/generate-customer-portal-authentication-token.md): Generates an authentication token for customer portal access using either customer ID or email address. This token can be used to create magic links or authenticate API requests on behalf of a customer.
- [Generate customer portal magic link](https://developers.appstle.com/api-reference/membership-contracts/generate-customer-portal-magic-link.md): Generates a secure, time-limited magic link that allows customers to access and manage their subscriptions. This passwordless authentication link directs customers to the subscription management portal.
- [Get billing interval options for selling plans](https://developers.appstle.com/api-reference/membership-contracts/get-billing-interval-options-for-selling-plans.md): Retrieves available billing frequency/interval options for specified Shopify selling plans (subscription plans). This endpoint returns all configured billing frequencies that customers can choose from for their subscriptions.
- [Get current billing cycle](https://developers.appstle.com/api-reference/membership-contracts/get-current-billing-cycle.md): Retrieves the current billing cycle number for a specific subscription contract.
- [Get current customer's membership subscription profile](https://developers.appstle.com/api-reference/membership-contracts/get-current-customers-membership-subscription-profile.md)
- [Get customer payment methods](https://developers.appstle.com/api-reference/membership-contracts/get-customer-payment-methods.md): Retrieves available Shopify payment methods for a specific customer from the customer portal.
- [Get customer subscription details](https://developers.appstle.com/api-reference/membership-contracts/get-customer-subscription-details.md): Retrieves subscription contract customer details and order notes for a specific contract.
- [Get detailed customer subscription information](https://developers.appstle.com/api-reference/membership-contracts/get-detailed-customer-subscription-information.md): Retrieves comprehensive details for all subscription contracts associated with a specific customer. This endpoint returns complete subscription contract data including products, pricing, billing schedule, and status.
- [Get membership/subscription contract list](https://developers.appstle.com/api-reference/membership-contracts/get-membershipsubscription-contract-list.md): Retrieves a paginated list of membership/subscription contracts with advanced filtering capabilities. This endpoint provides comprehensive access to all subscription contracts in your store with flexible query options.
- [Get pending downgrade](https://developers.appstle.com/api-reference/membership-contracts/get-pending-downgrade.md): Retrieves pending plan downgrade information for a subscription contract.
- [Get pending downgrade for a subscription contract](https://developers.appstle.com/api-reference/membership-contracts/get-pending-downgrade-for-a-subscription-contract.md): Retrieves the pending/scheduled downgrade details for a specific subscription contract. This endpoint returns information about a downgrade that has been scheduled but not yet executed.
- [Get raw Shopify subscription contract data](https://developers.appstle.com/api-reference/membership-contracts/get-raw-shopify-subscription-contract-data.md)
- [Get raw subscription contract details from Shopify](https://developers.appstle.com/api-reference/membership-contracts/get-raw-subscription-contract-details-from-shopify.md): Retrieves the complete subscription contract data directly from Shopify's GraphQL API. This returns the full, unmodified Shopify contract object with all nested data.
- [Get subscription contract details](https://developers.appstle.com/api-reference/membership-contracts/get-subscription-contract-details.md): Retrieves the raw subscription contract details for a specific contract by ID.
- [Get subscription customer details](https://developers.appstle.com/api-reference/membership-contracts/get-subscription-customer-details.md): Retrieves comprehensive customer information from Shopify for a specific customer ID. This endpoint fetches the customer record directly from Shopify's API, returning all personal details, addresses, payment methods, and metadata associated with the customer account.
- [Get subscription order fulfillment details](https://developers.appstle.com/api-reference/membership-contracts/get-subscription-order-fulfillment-details.md): Retrieves fulfillment information for the most recent order generated by a subscription contract. Shows shipping status, tracking numbers, and delivery progress.
- [Get valid subscription contract IDs for customer](https://developers.appstle.com/api-reference/membership-contracts/get-valid-subscription-contract-ids-for-customer.md): Retrieves a list of all valid (active, paused, or pending) subscription contract IDs associated with a specific customer. This endpoint is useful for quickly checking which subscriptions a customer has without retrieving full contract details.
- [Get valid subscription contracts for a customer](https://developers.appstle.com/api-reference/membership-contracts/get-valid-subscription-contracts-for-a-customer.md)
- [List current customer's valid subscription contract IDs](https://developers.appstle.com/api-reference/membership-contracts/list-current-customers-valid-subscription-contract-ids.md)
- [List Shopify fulfillments for a subscription contract](https://developers.appstle.com/api-reference/membership-contracts/list-shopify-fulfillments-for-a-subscription-contract.md)
- [Remove discount from contract](https://developers.appstle.com/api-reference/membership-contracts/remove-discount-from-contract.md): Removes an applied discount from a subscription contract from the customer portal.
- [Remove discount from subscription](https://developers.appstle.com/api-reference/membership-contracts/remove-discount-from-subscription.md): Removes a discount from a subscription contract. This endpoint allows you to remove previously applied discounts, restoring the subscription to full price.
- [Remove line item from contract](https://developers.appstle.com/api-reference/membership-contracts/remove-line-item-from-contract.md): Removes a product line item from a subscription contract from the customer portal.
- [Remove product from recurring subscription](https://developers.appstle.com/api-reference/membership-contracts/remove-product-from-recurring-subscription.md): Removes a line item (product) from a subscription contract. The product will no longer be included in future recurring orders.
- [Send customer portal magic link via email](https://developers.appstle.com/api-reference/membership-contracts/send-customer-portal-magic-link-via-email.md): Automatically generates and emails a secure magic link to the customer for accessing their subscription management portal. This is a convenience endpoint that combines token generation and email delivery in a single API call.
- [Send magic link email](https://developers.appstle.com/api-reference/membership-contracts/send-magic-link-email.md): Sends a magic link email to the customer for passwordless access to manage their subscription.
- [Sync customer information](https://developers.appstle.com/api-reference/membership-contracts/sync-customer-information.md): Triggers synchronization of customer information from Shopify for the specified customer ID.
- [Update billing interval](https://developers.appstle.com/api-reference/membership-contracts/update-billing-interval.md): Updates the billing frequency interval for a subscription contract from the customer portal.
- [Update billing interval for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-billing-interval-for-subscription-contract.md): Changes the billing frequency of a subscription contract. This allows customers to modify how often they are charged for their membership.
- [Update custom attributes on subscription line item](https://developers.appstle.com/api-reference/membership-contracts/update-custom-attributes-on-subscription-line-item.md): Updates custom attributes (metadata) on a specific subscription line item. Attributes allow storing custom key-value data on individual products in a subscription.
- [Update custom note attributes on subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-custom-note-attributes-on-subscription-contract.md): Updates custom note attributes (key-value pairs) on a subscription contract. These attributes are stored on the Shopify subscription contract and propagated to recurring orders.
- [Update delivery interval for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-delivery-interval-for-subscription-contract.md): Changes the delivery/shipping frequency of a subscription contract. This allows customers to modify how often they receive their subscription orders.
- [Update existing payment method details](https://developers.appstle.com/api-reference/membership-contracts/update-existing-payment-method-details.md): Updates the details of an existing payment method associated with a subscription contract.
- [Update line item attributes](https://developers.appstle.com/api-reference/membership-contracts/update-line-item-attributes.md): Updates custom attributes on a subscription contract line item from the customer portal.
- [Update line item variant](https://developers.appstle.com/api-reference/membership-contracts/update-line-item-variant.md): Updates the product variant for a line item in a subscription contract, allowing customers to swap to a different variant.
- [Update maximum billing cycles for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-maximum-billing-cycles-for-subscription-contract.md): Sets the maximum number of billing cycles (payments) after which the subscription will automatically expire and cancel. This is useful for creating fixed-term memberships or limited-duration subscriptions.
- [Update membership contract status](https://developers.appstle.com/api-reference/membership-contracts/update-membership-contract-status.md): Updates the status of an existing membership contract (ACTIVE, PAUSED, CANCELLED, or EXPIRED). This is one of the most critical operations for managing membership lifecycles.
- [Update minimum billing cycles for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-minimum-billing-cycles-for-subscription-contract.md): Sets the minimum number of billing cycles (payments) required before a customer can cancel their subscription. This is commonly used to enforce commitment periods or prevent early cancellations.
- [Update next billing date](https://developers.appstle.com/api-reference/membership-contracts/update-next-billing-date.md): Updates the next billing date for a subscription contract from the customer portal.
- [Update order note](https://developers.appstle.com/api-reference/membership-contracts/update-order-note.md): Updates the order note for a subscription contract from the customer portal.
- [Update order note/instructions for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-order-noteinstructions-for-subscription-contract.md): Updates the persistent order note attached to a subscription contract. This note is automatically included with **EVERY future recurring order** generated from this subscription, appearing in Shopify admin order details and printable packing slips.
- [Update payment method](https://developers.appstle.com/api-reference/membership-contracts/update-payment-method.md): Updates the payment method associated with a subscription contract from the customer portal.
- [Update product variant in subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-product-variant-in-subscription-contract.md): Replaces an existing product variant with a new variant in a subscription contract. This allows customers to swap products in their membership while maintaining their subscription.
- [Update shipping address](https://developers.appstle.com/api-reference/membership-contracts/update-shipping-address.md): Updates the shipping/delivery address for a subscription contract from the customer portal.
- [Update shipping address for subscription contract](https://developers.appstle.com/api-reference/membership-contracts/update-shipping-address-for-subscription-contract.md): Changes the delivery shipping address for a subscription contract. This allows customers to update where their subscription orders are delivered.
- [Update subscription contract billing date](https://developers.appstle.com/api-reference/membership-contracts/update-subscription-contract-billing-date.md): Updates the next billing date for a subscription contract. This reschedules when the next payment will be charged for the membership.
- [Update subscription contract details](https://developers.appstle.com/api-reference/membership-contracts/update-subscription-contract-details.md): Updates an existing subscription contract's details from the customer portal.
- [Update subscription contract status (pause/resume/activate)](https://developers.appstle.com/api-reference/membership-contracts/update-subscription-contract-status-pauseresumeactivate.md): Changes the status of a subscription contract. This allows pausing, resuming, or activating subscriptions to control billing and delivery.
- [Update subscription line item quantity and pricing](https://developers.appstle.com/api-reference/membership-contracts/update-subscription-line-item-quantity-and-pricing.md): Updates an existing line item in a subscription contract, modifying quantity, variant, or price. This endpoint allows comprehensive updates to subscription products.
- [Update subscription payment method](https://developers.appstle.com/api-reference/membership-contracts/update-subscription-payment-method.md): Updates the payment method for a subscription contract by refreshing payment instrument from Shopify customer. This endpoint syncs the subscription's payment method with the customer's default payment method in Shopify.
- [Get a membership plan group](https://developers.appstle.com/api-reference/membership-plans/get-a-membership-plan-group.md): Retrieves a specific membership/subscription plan group by its Shopify selling plan group ID, including all plan configurations and assigned products.
- [Get all selling plans](https://developers.appstle.com/api-reference/membership-plans/get-all-selling-plans.md): Retrieves all available selling plans for the customer portal, used to display plan options to customers.
- [List all membership plan groups](https://developers.appstle.com/api-reference/membership-plans/list-all-membership-plan-groups.md): Retrieves all membership/subscription plan groups for the authenticated shop, including plan details, discount configurations, and product assignments.
- [Add one-time product to upcoming order](https://developers.appstle.com/api-reference/one-time-add-ons/add-one-time-product-to-upcoming-order.md): Adds a one-time product (one-off) to a specific upcoming billing attempt for a membership contract. The product will be included only in the specified order and will not become part of the recurring subscription.
- [Add or update one-off item](https://developers.appstle.com/api-reference/one-time-add-ons/add-or-update-one-off-item.md): Adds or updates a one-time product for a specific subscription contract's upcoming billing attempt.
- [Get one-off items for contract](https://developers.appstle.com/api-reference/one-time-add-ons/get-one-off-items-for-contract.md): Retrieves all one-time add-on products associated with a specific subscription contract and billing attempt.
- [Get one-time add-ons for a membership contract](https://developers.appstle.com/api-reference/one-time-add-ons/get-one-time-add-ons-for-a-membership-contract.md): Retrieves all one-time product additions scheduled for upcoming orders of a specific membership contract. One-offs are products added to a single billing cycle without affecting the recurring subscription items.
- [Remove one-time product from upcoming order](https://developers.appstle.com/api-reference/one-time-add-ons/remove-one-time-product-from-upcoming-order.md): Removes a previously added one-time product (one-off) from a specific upcoming billing attempt. This allows customers or merchants to cancel add-on items before the order is processed.
- [Bulk update subscription billing interval](https://developers.appstle.com/api-reference/operations-&-settings/bulk-update-subscription-billing-interval.md): Updates the billing interval configuration for subscription contracts in bulk.
- [Bulk update subscription delivery method](https://developers.appstle.com/api-reference/operations-&-settings/bulk-update-subscription-delivery-method.md): Updates the delivery method configuration for subscription contracts in bulk.
- [Bulk update subscription delivery price](https://developers.appstle.com/api-reference/operations-&-settings/bulk-update-subscription-delivery-price.md): Updates the delivery price for subscription contracts in bulk.
- [Create a new shipping/delivery profile](https://developers.appstle.com/api-reference/operations-&-settings/create-a-new-shippingdelivery-profile.md): Creates a new shipping or delivery profile for subscription orders. This endpoint allows you to configure custom shipping rates, delivery methods, and shipping zones for your subscription products. Delivery profiles control how subscription products are shipped to customers.
- [Create a new shipping/delivery profile (V2)](https://developers.appstle.com/api-reference/operations-&-settings/create-a-new-shippingdelivery-profile-v2.md): Creates a new shipping or delivery profile for subscription orders using the V2 request format. This version provides enhanced configuration options for delivery methods, zones, and pricing.
- [Create a new shipping/delivery profile (V3)](https://developers.appstle.com/api-reference/operations-&-settings/create-a-new-shippingdelivery-profile-v3.md): Creates a new shipping or delivery profile for subscription orders using the V3 request format. This is the latest version with the most comprehensive delivery profile configuration capabilities.
- [Get cancellation management configuration](https://developers.appstle.com/api-reference/operations-&-settings/get-cancellation-management-configuration.md): Retrieves the cancellation management and retention settings for the authenticated shop. These settings control the subscription cancellation flow, retention strategies, and customer feedback collection when subscribers attempt to cancel their subscriptions.
- [Get/Search activity logs](https://developers.appstle.com/api-reference/operations-&-settings/getsearch-activity-logs.md): Retrieves activity logs for all subscription-related events and changes in the authenticated shop. Activity logs provide a comprehensive audit trail of all subscription activities, changes, and system events.
- [Hide subscriptions in bulk](https://developers.appstle.com/api-reference/operations-&-settings/hide-subscriptions-in-bulk.md): Hides multiple subscription contracts from customer view in bulk. This operation allows merchants to quickly hide subscriptions from appearing in the customer portal without canceling or deleting them.
- [Replace products in subscriptions in bulk](https://developers.appstle.com/api-reference/operations-&-settings/replace-products-in-subscriptions-in-bulk.md): Replaces old product variants with new product variants across multiple subscription contracts in bulk. This powerful operation allows merchants to update products in active subscriptions when products are discontinued, reformulated, or repackaged.
- [Add points to customer account](https://developers.appstle.com/api-reference/points-&-earn-rules/add-points-to-customer-account.md)
- [Add store credits to customer account](https://developers.appstle.com/api-reference/points-&-earn-rules/add-store-credits-to-customer-account.md)
- [Approve pending point transactions](https://developers.appstle.com/api-reference/points-&-earn-rules/approve-pending-point-transactions.md)
- [Claim social media reward points](https://developers.appstle.com/api-reference/points-&-earn-rules/claim-social-media-reward-points.md)
- [Get all point earning rules](https://developers.appstle.com/api-reference/points-&-earn-rules/get-all-point-earning-rules.md)
- [Get customer point transaction history](https://developers.appstle.com/api-reference/points-&-earn-rules/get-customer-point-transaction-history.md)
- [Get top customers by points earned](https://developers.appstle.com/api-reference/points-&-earn-rules/get-top-customers-by-points-earned.md)
- [Remove points from customer account](https://developers.appstle.com/api-reference/points-&-earn-rules/remove-points-from-customer-account.md)
- [Track customer store visit](https://developers.appstle.com/api-reference/points-&-earn-rules/track-customer-store-visit.md)
- [Get contextual pricing for a variant by currency](https://developers.appstle.com/api-reference/product-&-inventory-data/get-contextual-pricing-for-a-variant-by-currency.md)
- [Get product details by ID](https://developers.appstle.com/api-reference/product-&-inventory-data/get-product-details-by-id.md)
- [Get product with selling plans and variants](https://developers.appstle.com/api-reference/product-&-inventory-data/get-product-with-selling-plans-and-variants.md)
- [List products attached to selling plans](https://developers.appstle.com/api-reference/product-&-inventory-data/list-products-attached-to-selling-plans.md)
- [Search subscription-enabled products with pagination](https://developers.appstle.com/api-reference/product-&-inventory-data/search-subscription-enabled-products-with-pagination.md)
- [Generate bundle-specific discount code](https://developers.appstle.com/api-reference/product-bundles/generate-bundle-specific-discount-code.md): Creates a Shopify discount code specifically for a subscription bundle. This endpoint generates unique, single-use or multi-use discount codes tied to bundle purchases.
- [Get bundle details by handle](https://developers.appstle.com/api-reference/product-bundles/get-bundle-details-by-handle.md): Retrieves detailed information about a subscription product bundle including bundled items, pricing, and subscription plan details.
- [Create a new product swap automation](https://developers.appstle.com/api-reference/product-catalog/create-a-new-product-swap-automation.md): Creates a new product swap automation rule for the authenticated shop. Product swaps automatically replace products in subscription orders based on billing cycles or recurring schedules.
- [Delete a product swap automation](https://developers.appstle.com/api-reference/product-catalog/delete-a-product-swap-automation.md): Permanently deletes a product swap automation configuration. Once deleted, the swap will no longer be applied to any subscription orders. Existing subscriptions that have already had products swapped are not affected.
- [Get a specific product swap by ID](https://developers.appstle.com/api-reference/product-catalog/get-a-specific-product-swap-by-id.md): Retrieves detailed information about a specific product swap automation configuration. This endpoint returns complete details about the source products, destination products, swap triggers, and all associated settings.
- [Get all product swaps for a shop](https://developers.appstle.com/api-reference/product-catalog/get-all-product-swaps-for-a-shop.md): Retrieves all configured product swap automations for the authenticated shop. Product swaps allow automatic replacement of products in subscription orders based on billing cycles or recurring schedules.
- [Get product swap variant groups for a contract](https://developers.appstle.com/api-reference/product-catalog/get-product-swap-variant-groups-for-a-contract.md): Retrieves product swap variant groups for the next 10 billing cycles of a specific subscription contract. This endpoint calculates and returns which products will be swapped to in future billing cycles based on configured swap automations.
- [Get variant data for a list of variant IDs](https://developers.appstle.com/api-reference/product-catalog/get-variant-data-for-a-list-of-variant-ids.md)
- [List discount rules applicable to bundles](https://developers.appstle.com/api-reference/product-catalog/list-discount-rules-applicable-to-bundles.md)
- [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/api-reference/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md)
- [Update an existing product swap automation](https://developers.appstle.com/api-reference/product-catalog/update-an-existing-product-swap-automation.md): Updates an existing product swap automation rule for the authenticated shop. Use this endpoint to modify swap configurations, change source/destination products, adjust timing, or update discount handling.
- [Get product swap options by variant](https://developers.appstle.com/api-reference/product-swap-rules/get-product-swap-options-by-variant.md): Retrieves available product swap/substitution options for specified variant IDs, allowing customers to exchange subscription items.
- [Get product swap options for subscription items](https://developers.appstle.com/api-reference/product-swap-rules/get-product-swap-options-for-subscription-items.md): Retrieves available product swap/substitution options for specified variants based on configured swap rules. Returns multiple levels of swap suggestions allowing members to exchange products in their subscriptions.
- [Check discount code validity](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/check-discount-code-validity.md)
- [Get all point redemption rules](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/get-all-point-redemption-rules.md)
- [Redeem customer loyalty points](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/redeem-customer-loyalty-points.md)
- [Redeem customer points for rewards](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/redeem-customer-points-for-rewards.md)
- [Update discount code status](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/update-discount-code-status.md)
- [Update discount code status (legacy endpoint)](https://developers.appstle.com/api-reference/redemptions-&-discount-codes/update-discount-code-status-legacy-endpoint.md)
- [Accept referral offer (GET)](https://developers.appstle.com/api-reference/referrals/accept-referral-offer-get.md)
- [Accept referral offer (POST)](https://developers.appstle.com/api-reference/referrals/accept-referral-offer-post.md)
- [Generate customer referral URL](https://developers.appstle.com/api-reference/referrals/generate-customer-referral-url.md)
- [Get customer referral history](https://developers.appstle.com/api-reference/referrals/get-customer-referral-history.md)
- [Send customer referral email](https://developers.appstle.com/api-reference/referrals/send-customer-referral-email.md)
- [Get product reviews by product ID](https://developers.appstle.com/api-reference/reviews/get-product-reviews-by-product-id.md)
- [Submit product review](https://developers.appstle.com/api-reference/reviews/submit-product-review.md)
- [Create shipping/delivery profile (V1 format - Legacy)](https://developers.appstle.com/api-reference/shipping-&-delivery-profiles/create-shippingdelivery-profile-v1-format--legacy.md): Creates a new Shopify delivery profile with shipping zones and rates using the legacy V1 format. For new integrations, prefer the V2 endpoint which supports more advanced configuration.
- [Create shipping/delivery profile (V2 format)](https://developers.appstle.com/api-reference/shipping-&-delivery-profiles/create-shippingdelivery-profile-v2-format.md): Creates a new Shopify delivery profile with custom shipping zones, rates, and methods. Delivery profiles control which shipping options are available to customers at checkout for subscription orders.
- [Get pickup locations](https://developers.appstle.com/api-reference/shipping-&-delivery-profiles/get-pickup-locations.md): Retrieves available pickup locations for the customer's subscription delivery.
- [Get shop info for current user](https://developers.appstle.com/api-reference/shop-settings/get-shop-info-for-current-user.md): Retrieves shop information and membership settings for the currently authenticated customer's shop.
- [List storefront widget label translations](https://developers.appstle.com/api-reference/storefront-widgets-&-labels/list-storefront-widget-label-translations.md)
- [Add a line item to a specific section of a contract](https://developers.appstle.com/api-reference/subscription-contracts/add-a-line-item-to-a-specific-section-of-a-contract.md)
- [Add a line item to a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/add-a-line-item-to-a-subscription-contract.md)
- [Add custom discount to subscription](https://developers.appstle.com/api-reference/subscription-contracts/add-custom-discount-to-subscription.md): Creates and applies a custom manual discount to an existing subscription contract. This powerful endpoint supports multiple discount types and configurations for flexible pricing strategies.
- [Apply a cancellation-flow discount to a contract](https://developers.appstle.com/api-reference/subscription-contracts/apply-a-cancellation-flow-discount-to-a-contract.md)
- [Apply a discount code to a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/apply-a-discount-code-to-a-subscription-contract.md)
- [Apply discount code to subscription](https://developers.appstle.com/api-reference/subscription-contracts/apply-discount-code-to-subscription.md): Applies a Shopify discount code to an existing subscription contract. The discount will be applied to future orders generated by this subscription.
- [Associate external payment gateway customer with Shopify customer](https://developers.appstle.com/api-reference/subscription-contracts/associate-external-payment-gateway-customer-with-shopify-customer.md): Links a customer's payment profile from an external payment gateway (Stripe, Braintree, PayPal, Authorize.Net) to their Shopify customer account. This enables Shopify subscription billing to charge payment methods stored in external gateways, which is essential for migrating existing subscriptions o…
- [Cancel a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/cancel-a-subscription-contract.md): Cancels an existing subscription contract. This operation terminates all future billing and delivery cycles for the subscription. The cancellation takes effect immediately.
- [Cancel and delete a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/cancel-and-delete-a-subscription-contract.md)
- [Change contract frequency by selecting a new selling plan](https://developers.appstle.com/api-reference/subscription-contracts/change-contract-frequency-by-selecting-a-new-selling-plan.md)
- [Check whether anchor day overwrite is enabled](https://developers.appstle.com/api-reference/subscription-contracts/check-whether-anchor-day-overwrite-is-enabled.md)
- [Edit custom attributes on a single line item](https://developers.appstle.com/api-reference/subscription-contracts/edit-custom-attributes-on-a-single-line-item.md)
- [Email customer portal magic link to subscriber](https://developers.appstle.com/api-reference/subscription-contracts/email-customer-portal-magic-link-to-subscriber.md)
- [Generate customer portal authentication token](https://developers.appstle.com/api-reference/subscription-contracts/generate-customer-portal-authentication-token.md): Generates a secure, time-limited authentication token that grants access to the customer portal. Supports lookup by either Shopify customer ID or customer email address, making it flexible for various integration patterns.
- [Get current billing cycle for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/get-current-billing-cycle-for-a-subscription-contract.md)
- [Get current customer's saved Shopify payment methods](https://developers.appstle.com/api-reference/subscription-contracts/get-current-customers-saved-shopify-payment-methods.md)
- [Get current customer's subscription profile](https://developers.appstle.com/api-reference/subscription-contracts/get-current-customers-subscription-profile.md)
- [Get currently logged-in customer ID](https://developers.appstle.com/api-reference/subscription-contracts/get-currently-logged-in-customer-id.md): Returns the customer ID of the currently authenticated customer from their Shopify session. This endpoint is used by the customer portal UI to identify which customer is logged in.
- [Get order note for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/get-order-note-for-a-subscription-contract.md)
- [Get raw Shopify subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/get-raw-shopify-subscription-contract.md)
- [Get raw Shopify subscription contract (external view)](https://developers.appstle.com/api-reference/subscription-contracts/get-raw-shopify-subscription-contract-external-view.md)
- [Get subscription contract as a flattened map](https://developers.appstle.com/api-reference/subscription-contracts/get-subscription-contract-as-a-flattened-map.md)
- [Get valid subscription contracts for a customer](https://developers.appstle.com/api-reference/subscription-contracts/get-valid-subscription-contracts-for-a-customer.md)
- [List a customer's valid subscription contract IDs](https://developers.appstle.com/api-reference/subscription-contracts/list-a-customers-valid-subscription-contract-ids.md)
- [List Shopify fulfillments for a specific order](https://developers.appstle.com/api-reference/subscription-contracts/list-shopify-fulfillments-for-a-specific-order.md)
- [List Shopify fulfillments for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/list-shopify-fulfillments-for-a-subscription-contract.md)
- [Merge an existing contract into another](https://developers.appstle.com/api-reference/subscription-contracts/merge-an-existing-contract-into-another.md)
- [Remove a discount from a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/remove-a-discount-from-a-subscription-contract.md)
- [Remove a line item from a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/remove-a-line-item-from-a-subscription-contract.md)
- [Remove discount from subscription](https://developers.appstle.com/api-reference/subscription-contracts/remove-discount-from-subscription.md): Removes a specific discount from a subscription contract based on the discount ID. This will affect the pricing of all future orders generated by the subscription.
- [Replace all line item attributes in bulk across subscription contracts](https://developers.appstle.com/api-reference/subscription-contracts/replace-all-line-item-attributes-in-bulk-across-subscription-contracts.md): This API replaces all existing attributes for the specified line items within subscription contracts. Use carefully, as any attributes not included in the request will be removed.
- [Replace contract variants in bulk (v2)](https://developers.appstle.com/api-reference/subscription-contracts/replace-contract-variants-in-bulk-v2.md)
- [Reschedule a planned subscription fulfillment](https://developers.appstle.com/api-reference/subscription-contracts/reschedule-a-planned-subscription-fulfillment.md)
- [Retrieve raw Shopify GraphQL response for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/retrieve-raw-shopify-graphql-response-for-a-subscription-contract.md): Fetches the complete, unprocessed JSON response directly from Shopify's GraphQL API for the specified subscription contract. This endpoint returns the full subscription data structure as provided by Shopify, including all nested objects and relationships.
- [Retrieve subscription contracts](https://developers.appstle.com/api-reference/subscription-contracts/retrieve-subscription-contracts.md): Retrieves a paginated list of subscription contracts with powerful filtering capabilities. This endpoint enables complex queries to find specific subscriptions based on various criteria including dates, customer information, product details, and subscription characteristics.
- [Send magic link email to customer for portal access](https://developers.appstle.com/api-reference/subscription-contracts/send-magic-link-email-to-customer-for-portal-access.md): Sends an automated email to a customer containing a secure magic link for accessing their subscription management portal. The email is sent using the shop's configured email template and includes a time-limited authentication token.
- [Set existing Shopify payment method on contract](https://developers.appstle.com/api-reference/subscription-contracts/set-existing-shopify-payment-method-on-contract.md)
- [Skip or unskip a product line item for next order](https://developers.appstle.com/api-reference/subscription-contracts/skip-or-unskip-a-product-line-item-for-next-order.md)
- [Swap a product within a Build-a-Box subscription](https://developers.appstle.com/api-reference/subscription-contracts/swap-a-product-within-a-build-a-box-subscription.md)
- [Sync shipping price on contract from delivery profile](https://developers.appstle.com/api-reference/subscription-contracts/sync-shipping-price-on-contract-from-delivery-profile.md)
- [Trigger payment method re-collection email](https://developers.appstle.com/api-reference/subscription-contracts/trigger-payment-method-re-collection-email.md)
- [Update billing interval for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-billing-interval-for-a-subscription-contract.md): Updates the billing frequency (how often the customer is charged) for a subscription contract. This comprehensive operation recalculates billing dates, adjusts pricing, updates selling plans, and may also modify delivery intervals.
- [Update custom attributes on contract line items](https://developers.appstle.com/api-reference/subscription-contracts/update-custom-attributes-on-contract-line-items.md)
- [Update delivery method on a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-delivery-method-on-a-subscription-contract.md)
- [Update freeze (skip-billing) status on a contract](https://developers.appstle.com/api-reference/subscription-contracts/update-freeze-skip-billing-status-on-a-contract.md)
- [Update line item attributes for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-line-item-attributes-for-a-subscription-contract.md): Updates the custom attributes for a specific line item within a subscription contract. This endpoint accepts a contract ID, a line item ID, and a list of attribute objects (each containing key/value pairs) to update. It uses the underlying service to perform validation (such as contract existence, f…
- [Update line item quantities for a classic Build-a-Box subscription](https://developers.appstle.com/api-reference/subscription-contracts/update-line-item-quantities-for-a-classic-build-a-box-subscription.md)
- [Update line item quantity on a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-line-item-quantity-on-a-subscription-contract.md)
- [Update multiple line item attributes for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-multiple-line-item-attributes-for-a-subscription-contract.md): Updates custom attributes for multiple line items within a subscription contract. The request body must be a JSON object where each key is a line item identifier (as a String) and each value is a list of AttributeInfo objects containing attribute key/value pairs. For example: { "gid://shopify/Subscr…
- [Update next billing date for a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-next-billing-date-for-a-subscription-contract.md): Reschedules the next billing date for an active subscription contract. This endpoint allows you to change when the next order will be created and processed.
- [Update order note on a subscription contract](https://developers.appstle.com/api-reference/subscription-contracts/update-order-note-on-a-subscription-contract.md)
- [Update product-level custom attributes on a contract](https://developers.appstle.com/api-reference/subscription-contracts/update-product-level-custom-attributes-on-a-contract.md)
- [Update subscription contract details](https://developers.appstle.com/api-reference/subscription-contracts/update-subscription-contract-details.md)
- [Update Subscription contract frequency by selling plan](https://developers.appstle.com/api-reference/subscription-contracts/update-subscription-contract-frequency-by-selling-plan.md)
- [Update subscription contract order note](https://developers.appstle.com/api-reference/subscription-contracts/update-subscription-contract-order-note.md)
- [Get delivery options for subscription contract](https://developers.appstle.com/api-reference/subscription-data/get-delivery-options-for-subscription-contract.md): Retrieves all valid delivery methods available for a specific subscription contract. Returns shipping profiles and delivery options based on the contract's delivery address and product characteristics.
- [Get product details by ID](https://developers.appstle.com/api-reference/subscription-data/get-product-details-by-id.md)
- [Get products data with pagination](https://developers.appstle.com/api-reference/subscription-data/get-products-data-with-pagination.md): Retrieves paginated product catalog data from Shopify, optionally filtered by search term, selling plans, or subscription contracts. This endpoint provides access to your store's product catalog with subscription-specific information.
- [Get selling plans for products](https://developers.appstle.com/api-reference/subscription-data/get-selling-plans-for-products.md): Retrieves all selling plans (subscription plans) associated with a set of products. This endpoint is useful for determining which subscription options are available for specific products.
- [Get variant contextual pricing](https://developers.appstle.com/api-reference/subscription-data/get-variant-contextual-pricing.md): Retrieves contextual pricing information for a product variant based on currency and country. This endpoint provides localized pricing data for international subscriptions and multi-currency support.
- [List delivery options available for the shop](https://developers.appstle.com/api-reference/subscription-data/list-delivery-options-available-for-the-shop.md)
- [List enabled presentment currencies for the shop](https://developers.appstle.com/api-reference/subscription-data/list-enabled-presentment-currencies-for-the-shop.md)
- [List product handles for the shop](https://developers.appstle.com/api-reference/subscription-data/list-product-handles-for-the-shop.md)
- [List products with their selling plans (v2)](https://developers.appstle.com/api-reference/subscription-data/list-products-with-their-selling-plans-v2.md)
- [List saved addresses for the current customer](https://developers.appstle.com/api-reference/subscription-data/list-saved-addresses-for-the-current-customer.md)
- [List subscription products available to the customer](https://developers.appstle.com/api-reference/subscription-data/list-subscription-products-available-to-the-customer.md)
- [List subscription products filtered by selling plans](https://developers.appstle.com/api-reference/subscription-data/list-subscription-products-filtered-by-selling-plans.md)
- [List supported shipping countries](https://developers.appstle.com/api-reference/subscription-data/list-supported-shipping-countries.md)
- [Search subscription-enabled products with pagination](https://developers.appstle.com/api-reference/subscription-data/search-subscription-enabled-products-with-pagination.md)
- [Create a new subscription contract](https://developers.appstle.com/api-reference/subscription-management/create-a-new-subscription-contract.md): Creates a new subscription contract for a customer with specified products, billing frequency, and delivery details. This endpoint allows you to programmatically create subscriptions with custom pricing, delivery schedules, and multiple line items. The subscription will be created in Shopify and syn…
- [Get available billing intervals for selling plan(s)](https://developers.appstle.com/api-reference/subscription-management/get-available-billing-intervals-for-selling-plans.md): Retrieves all available billing frequency options configured for specific Shopify selling plan(s). Returns the complete set of billing intervals that customers can choose from, including frequency, interval type, and any associated discounts or pricing policies.
- [Get current billing cycle number for a subscription contract](https://developers.appstle.com/api-reference/subscription-management/get-current-billing-cycle-number-for-a-subscription-contract.md): Retrieves the current billing cycle number for a specific subscription contract. The cycle number represents how many successful billing attempts have occurred for this subscription, starting from 1 for the initial order.
- [Get raw Shopify GraphQL contract response](https://developers.appstle.com/api-reference/subscription-management/get-raw-shopify-graphql-contract-response.md): Retrieves the complete, unprocessed subscription contract data directly from Shopify's GraphQL API. This endpoint returns the full Shopify subscription contract object exactly as Shopify provides it, including all nested fields, relationships, and GraphQL metadata.
- [Get subscription contract analytics and revenue metrics](https://developers.appstle.com/api-reference/subscription-management/get-subscription-contract-analytics-and-revenue-metrics.md): Retrieves comprehensive analytics for a specific subscription contract, including total revenue generated, number of successful orders, and formatted revenue display. This endpoint provides key performance metrics for understanding the financial impact of individual subscriptions.
- [Get subscription fulfillment details for latest order](https://developers.appstle.com/api-reference/subscription-management/get-subscription-fulfillment-details-for-latest-order.md): Retrieves fulfillment information for the most recent successful order associated with a subscription contract. This includes tracking details, shipment status, delivery estimates, and fulfillment line items from Shopify.
- [List quick checkout links](https://developers.appstle.com/api-reference/subscription-management/list-quick-checkout-links.md)
- [Replace product variants in a subscription contract](https://developers.appstle.com/api-reference/subscription-management/replace-product-variants-in-a-subscription-contract.md): Replaces existing product variants with new ones in a subscription contract. This endpoint supports both regular subscription products and one-time products, allowing you to swap products, update quantities, and manage the product mix in a subscription.
- [Split or duplicate an existing subscription contract](https://developers.appstle.com/api-reference/subscription-management/split-or-duplicate-an-existing-subscription-contract.md): Creates a new subscription contract by either splitting (moving) or duplicating selected line items from an existing contract. This endpoint allows you to divide a subscription into multiple contracts or create a copy with specific products.
- [Update custom attributes on a subscription contract](https://developers.appstle.com/api-reference/subscription-management/update-custom-attributes-on-a-subscription-contract.md): Updates or replaces custom key-value attributes on a subscription contract. These attributes are stored with the subscription and can be used to track custom data, preferences, or metadata that's important for your business processes.
- [Update delivery interval for a subscription contract](https://developers.appstle.com/api-reference/subscription-management/update-delivery-interval-for-a-subscription-contract.md): Updates the delivery interval for the specified subscription contract. This endpoint allows external API consumers to change the delivery interval count and type (of type SellingPlanInterval) used for scheduling deliveries.
- [Update delivery price for a subscription contract](https://developers.appstle.com/api-reference/subscription-management/update-delivery-price-for-a-subscription-contract.md): Updates the fixed delivery price for all future orders in a subscription contract. This allows manual override of calculated shipping rates with a custom delivery fee.
- [Update maximum cycles for a subscription contract](https://developers.appstle.com/api-reference/subscription-management/update-maximum-cycles-for-a-subscription-contract.md): Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.
- [Update minimum cycles for a subscription contract](https://developers.appstle.com/api-reference/subscription-management/update-minimum-cycles-for-a-subscription-contract.md): Updates the minimum number of billing cycles (orders) that a customer must complete before they can cancel their subscription. This creates a commitment period that helps with customer retention and business predictability.
- [Update order note for subscription](https://developers.appstle.com/api-reference/subscription-management/update-order-note-for-subscription.md): Updates the order note that will be added to all future orders generated by this subscription. Order notes help merchants track special instructions, customer preferences, or internal information about the subscription.
- [Update subscription contract status](https://developers.appstle.com/api-reference/subscription-management/update-subscription-contract-status.md): Updates the status of a subscription contract to ACTIVE, PAUSED, or CANCELLED. This endpoint manages the lifecycle of subscriptions with automatic state tracking and notifications.
- [Update subscription delivery address and method](https://developers.appstle.com/api-reference/subscription-management/update-subscription-delivery-address-and-method.md): Updates the shipping address or delivery method for a subscription contract. Supports standard shipping, local delivery, and pickup options with comprehensive address validation.
- [Update subscription delivery method](https://developers.appstle.com/api-reference/subscription-management/update-subscription-delivery-method.md): Updates the delivery method for a subscription contract, supporting standard shipping, local delivery, and customer pickup options. The delivery method determines how future orders will be fulfilled.
- [Add one-time product to subscription order](https://developers.appstle.com/api-reference/subscription-one-time-products/add-one-time-product-to-subscription-order.md): Adds a one-time product (add-on) to a specific subscription order. The product will be included only in the specified billing attempt and will not recur in future orders. This endpoint is idempotent - attempting to add the same product to the same billing attempt will return success without creating…
- [Delete a one-time add-on from a billing attempt](https://developers.appstle.com/api-reference/subscription-one-time-products/delete-a-one-time-add-on-from-a-billing-attempt.md)
- [Get all one-time products for a subscription contract](https://developers.appstle.com/api-reference/subscription-one-time-products/get-all-one-time-products-for-a-subscription-contract.md): Retrieves all one-time products (add-ons) associated with a specific subscription contract across all billing attempts. One-time products are additional items that customers can add to their subscription orders on a non-recurring basis. Each one-time product is tied to a specific billing attempt and…
- [Get one-time add-ons for the next upcoming order](https://developers.appstle.com/api-reference/subscription-one-time-products/get-one-time-add-ons-for-the-next-upcoming-order.md)
- [Get one-time products for next upcoming order](https://developers.appstle.com/api-reference/subscription-one-time-products/get-one-time-products-for-next-upcoming-order.md): Retrieves one-time products that will be included in the next scheduled order for a subscription contract. This endpoint specifically returns products associated with the earliest queued billing attempt, making it ideal for showing customers what additional items will be in their next delivery.
- [List one-time add-on products for a contract](https://developers.appstle.com/api-reference/subscription-one-time-products/list-one-time-add-on-products-for-a-contract.md)
- [Remove one-time product from subscription order](https://developers.appstle.com/api-reference/subscription-one-time-products/remove-one-time-product-from-subscription-order.md): Removes a previously added one-time product from a specific subscription order. This permanently deletes the one-time product from the specified billing attempt. The operation is idempotent - attempting to delete a non-existent product will succeed without error.
- [Save a one-time add-on for a billing attempt](https://developers.appstle.com/api-reference/subscription-one-time-products/save-a-one-time-add-on-for-a-billing-attempt.md)
- [Update quantity of a one-time add-on](https://developers.appstle.com/api-reference/subscription-one-time-products/update-quantity-of-a-one-time-add-on.md)
- [Send payment method update email to customer](https://developers.appstle.com/api-reference/subscription-payments/send-payment-method-update-email-to-customer.md): Triggers Shopify to send an email to the subscription customer with a secure link to update their payment method. This endpoint initiates Shopify's native payment update flow without requiring direct payment handling.
- [Update subscription payment method](https://developers.appstle.com/api-reference/subscription-payments/update-subscription-payment-method.md): Updates the payment method for an existing subscription contract to use a different existing payment method. The new payment method must already be associated with the customer in Shopify.
- [Add products or variants to an existing subscription group](https://developers.appstle.com/api-reference/subscription-plans/add-products-or-variants-to-an-existing-subscription-group.md): Adds one or more products and/or product variants to an existing subscription group (selling plan group). This endpoint provides a simple way to expand the product catalog eligible for subscription without modifying the group's configuration or existing product assignments.
- [Bulk add products or variants to an existing subscription group](https://developers.appstle.com/api-reference/subscription-plans/bulk-add-products-or-variants-to-an-existing-subscription-group.md): Adds multiple products and/or product variants to an existing subscription group (selling plan group) using a JSON request body. This endpoint is ideal for adding large numbers of products/variants that would exceed URL length limits in the query parameter version.
- [Create a new subscription group (selling plan group)](https://developers.appstle.com/api-reference/subscription-plans/create-a-new-subscription-group-selling-plan-group.md): Creates a new subscription group with one or more selling plans in Shopify. A subscription group is a container for selling plans that can be applied to products and variants. Each group can contain multiple plans with different frequencies, discounts, and delivery schedules.
- [Get all selling plans across all subscription groups](https://developers.appstle.com/api-reference/subscription-plans/get-all-selling-plans-across-all-subscription-groups.md): Retrieves a flattened list of all selling plans from all subscription groups in the store. This endpoint provides a consolidated view of every subscription plan available, regardless of which group it belongs to.
- [Get all subscription groups](https://developers.appstle.com/api-reference/subscription-plans/get-all-subscription-groups.md): Retrieves a list of all subscription groups (selling plan groups) configured in the store. This endpoint provides a complete overview of all subscription offerings available.
- [Get subscription group by ID](https://developers.appstle.com/api-reference/subscription-plans/get-subscription-group-by-id.md): Retrieves detailed information about a specific subscription group (selling plan group) by its ID. This endpoint provides complete configuration details for a single subscription group.
- [List all selling plans available to the customer](https://developers.appstle.com/api-reference/subscription-plans/list-all-selling-plans-available-to-the-customer.md)
- [Remove products or variants from a subscription group](https://developers.appstle.com/api-reference/subscription-plans/remove-products-or-variants-from-a-subscription-group.md): Removes specified products and/or variants from an existing subscription group (selling plan group). This endpoint allows selective removal of products without affecting the group's configuration or other product assignments.
- [Remove products or variants from ALL subscription groups](https://developers.appstle.com/api-reference/subscription-plans/remove-products-or-variants-from-all-subscription-groups.md): Removes specified products and/or variants from ALL subscription groups in the store. This is a powerful bulk operation that affects every subscription group simultaneously.
- [Update subscription group details and product assignments](https://developers.appstle.com/api-reference/subscription-plans/update-subscription-group-details-and-product-assignments.md): Updates an existing subscription group (selling plan group) including its name, selling plans configuration, and optionally manages product/variant assignments. This endpoint provides comprehensive update capabilities for both the subscription group structure and its product associations.
- [Add multiple products to subscription](https://developers.appstle.com/api-reference/subscription-products/add-multiple-products-to-subscription.md): Adds multiple product line items to an existing subscription contract in a single request. This batch operation is more efficient than making multiple individual requests and ensures all products are added with consistent processing.
- [Add product to subscription](https://developers.appstle.com/api-reference/subscription-products/add-product-to-subscription.md): Adds a new product line item to an existing subscription contract. Can add either recurring products that will appear in each order or one-time products that appear only in the next order.
- [Add product with custom price to subscription](https://developers.appstle.com/api-reference/subscription-products/add-product-with-custom-price-to-subscription.md): Adds a new product line item with a custom price override to an existing subscription contract. This endpoint bypasses standard pricing and selling plans to set an exact price.
- [Remove multiple products from subscription](https://developers.appstle.com/api-reference/subscription-products/remove-multiple-products-from-subscription.md): Removes multiple product line items from an existing subscription contract in a single request. Products are removed sequentially, allowing partial success if errors occur.
- [Remove product from subscription](https://developers.appstle.com/api-reference/subscription-products/remove-product-from-subscription.md): Removes a specific product line item from an existing subscription contract. Can optionally retain prorated discounts associated with the removed product.
- [Update line item pricing policy with cycle-based discounts](https://developers.appstle.com/api-reference/subscription-products/update-line-item-pricing-policy-with-cycle-based-discounts.md): Sets up advanced pricing rules for a subscription line item that change based on the number of successful orders (cycles). This powerful feature enables loyalty discounts, promotional pricing tiers, and subscribe-and-save models.
- [Update multiple properties of a subscription line item](https://developers.appstle.com/api-reference/subscription-products/update-multiple-properties-of-a-subscription-line-item.md): Comprehensive endpoint for updating a subscription line item's quantity, price, product variant, and/or selling plan in a single API call. Changes are applied intelligently - only modified values trigger updates.
- [Update product line item price](https://developers.appstle.com/api-reference/subscription-products/update-product-line-item-price.md): Updates the base price of a specific product line item within a subscription contract. This endpoint intelligently handles pricing updates while preserving existing discount structures.
- [Update product line item quantity in subscription](https://developers.appstle.com/api-reference/subscription-products/update-product-line-item-quantity-in-subscription.md): Updates the quantity of a specific product line item within a subscription contract. This comprehensive operation handles quantity validation, discount recalculation, and special Build-a-Box constraints.
- [Update selling plan for a subscription line item](https://developers.appstle.com/api-reference/subscription-products/update-selling-plan-for-a-subscription-line-item.md): Updates the selling plan associated with a specific product line item in a subscription contract. Selling plans define the delivery schedule, pricing rules, and billing policies for subscription products.
- [Authenticate with the Appstle Loyalty API](https://developers.appstle.com/loyalty/authentication.md): Create an API key in the Appstle dashboard, pass it in the X-API-Key header on every request, and manage up to 10 keys per store with per-key revocation.
- [Appstle Loyalty third-party integration guide](https://developers.appstle.com/loyalty/integration-guide.md): Build a production integration with Appstle Loyalty. Covers authentication, base URL, point management, enrollment, rewards, store credits, and partner keys.
- [Appstle Loyalty: Points, VIP Tiers & Referrals](https://developers.appstle.com/loyalty/introduction.md): Appstle Loyalty provides Admin and Storefront REST APIs to build points programs, VIP tiers, and referrals on Shopify. Learn which API fits your use case.
- [Appstle Loyalty Shopify metafields and customer tags](https://developers.appstle.com/loyalty/metafields-and-tags.md): Shopify metafields and tags set by Appstle Loyalty: loyalty profiles, reward codes, product reviews, VIP tags, and referral tags — with schema examples.
- [Partner Integration Framework — overview](https://developers.appstle.com/loyalty/partner-framework-overview.md): Plain-language overview of the Partner Integration Framework for merchants and merchant success — how partner connections work, approval, and disconnect.
- [Partner Integration Framework](https://developers.appstle.com/loyalty/partner-integration.md): Build a seamless, zero-configuration integration between your app and Appstle Loyalty. Scoped API tokens, nonce handshake, and merchant-approved connections.
- [Get started with Appstle Loyalty API](https://developers.appstle.com/loyalty/quickstart.md): Create an API key, retrieve a customer's loyalty profile with points and VIP tier, then credit points to their account — all in under five minutes.
- [Shopify Flow triggers and actions for Appstle Loyalty](https://developers.appstle.com/loyalty/shopify-flow.md): Automate loyalty with Appstle's native Shopify Flow triggers and actions. Award points, assign VIP tiers, and issue store credits — no API code required.
- [Appstle Loyalty webhook events and setup](https://developers.appstle.com/loyalty/webhooks.md): Set up Appstle Loyalty webhooks to receive real-time notifications for point transactions, VIP tier changes, and referrals — with Svix signature verification.
- [Authenticate with the Appstle Memberships API](https://developers.appstle.com/memberships/authentication.md): Create API keys in your Appstle dashboard and pass them via the X-API-Key header. Manage up to 10 keys per store, each independently revocable.
- [Appstle Memberships Third-Party Integration Guide](https://developers.appstle.com/memberships/integration-guide.md): Integrate with Appstle Memberships: authentication, base URL, membership management, member data, access control, billing, and common integration patterns.
- [Appstle Memberships: Tiered Plans & Access Control](https://developers.appstle.com/memberships/introduction.md): Appstle Memberships lets you build recurring membership programs on Shopify with tiered plans and gated content — via Admin and Customer Portal APIs.
- [Membership Metafields and Customer Tags Reference](https://developers.appstle.com/memberships/metafields-and-tags.md): Shopify metafields and tags set by Appstle Memberships — what they contain, when they update, and how to use them for storefront gating and integrations.
- [Partner integration framework — overview](https://developers.appstle.com/memberships/partner-framework-overview.md): A merchant-success-friendly overview of the Appstle Memberships Partner Integration Framework — what it is, why it matters, and how merchants connect partners.
- [Memberships Partner Integration](https://developers.appstle.com/memberships/partner-integration.md): Build a seamless, zero-configuration integration between your app and Appstle Memberships using scoped API tokens and a nonce handshake.
- [Get Started with Appstle Memberships API](https://developers.appstle.com/memberships/quickstart.md): Go from zero to your first Memberships API response in minutes: create an API key, retrieve a customer's membership contracts, and check active status.
- [Automate Memberships with Shopify Flow Triggers](https://developers.appstle.com/memberships/shopify-flow.md): Automate membership workflows with Appstle's Shopify Flow triggers: tag customers, send emails, and update CRMs on lifecycle and billing events.
- [Membership Webhook Events and Signature Verification](https://developers.appstle.com/memberships/webhooks.md): Receive real-time membership lifecycle and billing event notifications via webhooks. Covers Svix signature verification, automatic retries, and idempotency.
- [Authenticate with the Appstle Subscriptions API](https://developers.appstle.com/subscription/authentication.md): Create and manage API keys in the Appstle dashboard, pass the X-API-Key header on every Admin API request, and use partner keys for third-party integrations.
- [Appstle Subscriptions frequently asked questions](https://developers.appstle.com/subscription/faq.md): Answers to common questions about widget customization, detecting subscription orders, customer portal setup, API authentication, and data privacy.
- [Appstle Subscriptions integration guide](https://developers.appstle.com/subscription/integration-guide.md): Integrate with Appstle Subscriptions: authentication, base URL, subscription management, product operations, discounts, shipping, past orders, and partner keys.
- [Appstle Subscriptions: Recurring Revenue for Shopify](https://developers.appstle.com/subscription/introduction.md): Learn how Appstle Subscriptions works, when to use the Admin API vs. the Storefront API, and what you can build with each interface.
- [JavaScript events for the Appstle storefront widget](https://developers.appstle.com/subscription/javascript-hooks.md): Listen to DOM events fired by the Appstle subscription widget, cart, customer portal, and Build-a-Box to add analytics, custom UI, and storefront integrations.
- [Shopify metafields and tags for Appstle Subscriptions](https://developers.appstle.com/subscription/metafields-and-tags.md): Reference for all Appstle Subscriptions metafields (namespace, keys, types) and customer/order tags, including Liquid template support for dynamic tag values.
- [Partner framework overview](https://developers.appstle.com/subscription/partner-framework-overview.md): Merchant-friendly overview of the Partner Integration Framework — what it is, how it works, and how merchants connect partners.
- [Partner integration framework](https://developers.appstle.com/subscription/partner-integration.md): Build a zero-configuration integration between your app and Appstle Subscriptions, with scoped API tokens per merchant.
- [Get started with Appstle Subscriptions API](https://developers.appstle.com/subscription/quickstart.md): Create your Appstle API key, make your first authenticated request, and retrieve a customer's subscriptions in under five minutes with working curl examples.
- [Automate subscriptions with Shopify Flow](https://developers.appstle.com/subscription/shopify-flow.md): Use Appstle's Shopify Flow triggers and actions to automate subscription workflows without API tokens — everything runs in Shopify's authenticated context.
- [Appstle Subscriptions webhook events and setup](https://developers.appstle.com/subscription/webhooks.md): Configure webhook endpoints to receive real-time subscription events, verify Svix signatures, handle retries, and troubleshoot delivery failures.

## OpenAPI Specs

- [admin-api-swagger](https://developers.appstle.com/subscription/admin-api-swagger.json)
- [storefront-api-swagger](https://developers.appstle.com/loyalty/storefront-api-swagger.json)
- [openapi](https://developers.appstle.com/api-reference/openapi.json)