# Appstle

## Docs

- [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 yo…
- [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 re…
- [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 subscr…
- [Appstle Subscriptions integration guide](https://developers.appstle.com/subscription/integration-guide.md): Integrate with Appstle Subscriptions: authentication, base URL, subscription management, product ope…
- [Build your own subscription frontend](https://developers.appstle.com/subscription/build-your-own-frontend.md): Use Appstle's Storefront APIs and JavaScript events to build a fully custom subscription UI — from r…
- [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 token…
- [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-Bo…
- [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,…
- [Partner Integration 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…
- [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 t…
- [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…
- [Get/Search activity logs](https://developers.appstle.com/subscription-admin-api/operations-&-settings/getsearch-activity-logs.md): Retrieves activity logs for all subscription-related events and changes in the authenticated shop. A…
- [Bulk update subscription billing interval](https://developers.appstle.com/subscription-admin-api/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/subscription-admin-api/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/subscription-admin-api/operations-&-settings/bulk-update-subscription-delivery-price.md): Updates the delivery price for subscription contracts in bulk.
- [Hide subscriptions in bulk](https://developers.appstle.com/subscription-admin-api/operations-&-settings/hide-subscriptions-in-bulk.md): Hides multiple subscription contracts from customer view in bulk. This operation allows merchants to…
- [Replace products in subscriptions in bulk](https://developers.appstle.com/subscription-admin-api/operations-&-settings/replace-products-in-subscriptions-in-bulk.md): Replaces old product variants with new product variants across multiple subscription contracts in bu…
- [Get cancellation management configuration](https://developers.appstle.com/subscription-admin-api/operations-&-settings/get-cancellation-management-configuration.md): Retrieves the cancellation management and retention settings for the authenticated shop. These setti…
- [Create a new shipping/delivery profile](https://developers.appstle.com/subscription-admin-api/operations-&-settings/create-a-new-shippingdelivery-profile.md): Creates a new shipping or delivery profile for subscription orders. This endpoint allows you to conf…
- [Create a new shipping/delivery profile (V2)](https://developers.appstle.com/subscription-admin-api/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…
- [Create a new shipping/delivery profile (V3)](https://developers.appstle.com/subscription-admin-api/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…
- [Associate external payment gateway customer with Shopify customer](https://developers.appstle.com/subscription-admin-api/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, Auth…
- [Retrieve raw Shopify GraphQL response for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 specifie…
- [Generate customer portal authentication token](https://developers.appstle.com/subscription-admin-api/subscription-contracts/generate-customer-portal-authentication-token.md): Generates a secure, time-limited authentication token that grants access to the customer portal. Sup…
- [Retrieve subscription contracts](https://developers.appstle.com/subscription-admin-api/subscription-contracts/retrieve-subscription-contracts.md): Retrieves a paginated list of subscription contracts with powerful filtering capabilities. This endp…
- [Add custom discount to subscription](https://developers.appstle.com/subscription-admin-api/subscription-contracts/add-custom-discount-to-subscription.md): Creates and applies a custom manual discount to an existing subscription contract. This powerful end…
- [Apply discount code to subscription](https://developers.appstle.com/subscription-admin-api/subscription-contracts/apply-discount-code-to-subscription.md): Applies a Shopify discount code to an existing subscription contract. The discount will be applied t…
- [Replace all line item attributes in bulk across subscription contracts](https://developers.appstle.com/subscription-admin-api/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…
- [Send magic link email to customer for portal access](https://developers.appstle.com/subscription-admin-api/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 subscripti…
- [Remove discount from subscription](https://developers.appstle.com/subscription-admin-api/subscription-contracts/remove-discount-from-subscription.md): Removes a specific discount from a subscription contract based on the discount ID. This will affect…
- [Update next billing date for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 c…
- [Update billing interval for a subscription contract](https://developers.appstle.com/subscription-admin-api/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…
- [Update Subscription contract frequency by compatible selling-plan frequency](https://developers.appstle.com/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-compatible-selling-plan-frequency.md): Strict compatible frequency update. Use frequencyKey from /api/data/external/v2/compatible-selling-p…
- [Update Subscription contract frequency by selling plan](https://developers.appstle.com/subscription-admin-api/subscription-contracts/update-subscription-contract-frequency-by-selling-plan.md)
- [Update line item attributes for a subscription contract](https://developers.appstle.com/subscription-admin-api/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…
- [Update multiple line item attributes for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 m…
- [Cancel a subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-contracts/cancel-a-subscription-contract.md): Cancels an existing subscription contract. This operation terminates all future billing and delivery…
- [Update an existing Build-A-Box subscription bundle](https://developers.appstle.com/subscription-admin-api/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 selecti…
- [Create a new Build-A-Box subscription bundle](https://developers.appstle.com/subscription-admin-api/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…
- [Retrieve Build-A-Box bundle details by handle for customer storefront](https://developers.appstle.com/subscription-admin-api/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) inste…
- [Retrieve a Build-A-Box bundle by ID](https://developers.appstle.com/subscription-admin-api/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 i…
- [Delete a Build-A-Box subscription bundle](https://developers.appstle.com/subscription-admin-api/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…
- [Get subscription bundle settings (Build-a-Box configuration)](https://developers.appstle.com/subscription-admin-api/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 customiz…
- [Update subscription bundling configuration](https://developers.appstle.com/subscription-admin-api/build-a-box-&-bundles/update-subscription-bundling-configuration.md): Updates the configuration for one or more subscription bundles (Build-a-Box). This endpoint allows b…
- [Generate discount code for bundle](https://developers.appstle.com/subscription-admin-api/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 t…
- [Get bundle details by handle](https://developers.appstle.com/subscription-admin-api/build-a-box-&-bundles/get-bundle-details-by-handle.md): Retrieves complete details for a subscription bundle using its unique handle. This endpoint returns…
- [Get customer portal settings](https://developers.appstle.com/subscription-admin-api/customization/get-customer-portal-settings.md): Retrieves the customer portal configuration and settings for the authenticated shop. The customer po…
- [Get custom CSS for customer portal](https://developers.appstle.com/subscription-admin-api/customization/get-custom-css-for-customer-portal.md): Retrieves the custom CSS styling configuration for the customer portal. This endpoint returns all cu…
- [Regenerate subscription widget scripts](https://developers.appstle.com/subscription-admin-api/customization/regenerate-subscription-widget-scripts.md): Triggers regeneration and deployment of subscription widget JavaScript files for the authenticated s…
- [Get customer retention activities](https://developers.appstle.com/subscription-admin-api/customer-retention/get-customer-retention-activities.md): Retrieves a paginated, filterable list of customer retention activities for the authenticated shop.…
- [Get delivery options for subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-data/get-delivery-options-for-subscription-contract.md): Retrieves all valid delivery methods available for a specific subscription contract. Returns shippin…
- [Generate customer portal access link by customer ID or email](https://developers.appstle.com/subscription-admin-api/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 manag…
- [Generate customer portal link](https://developers.appstle.com/subscription-admin-api/customers/generate-customer-portal-link.md): Generates a secure, time-limited link that allows customers to access their subscription management…
- [Retrieve customers with subscriptions](https://developers.appstle.com/subscription-admin-api/customers/retrieve-customers-with-subscriptions.md): Returns a paginated list of customers who have subscription contracts. Supports filtering by custome…
- [Get customer payment methods from Shopify](https://developers.appstle.com/subscription-admin-api/customers/get-customer-payment-methods-from-shopify.md): Retrieves all payment methods associated with a customer directly from Shopify's payment API. This e…
- [Get detailed subscription information for a customer](https://developers.appstle.com/subscription-admin-api/customers/get-detailed-subscription-information-for-a-customer.md): Retrieves comprehensive subscription contract details for a specific customer, including subscriptio…
- [Sync customer subscription details from Shopify](https://developers.appstle.com/subscription-admin-api/customers/sync-customer-subscription-details-from-shopify.md): Synchronizes customer subscription information from Shopify to the Appstle subscription system. This…
- [Get valid subscription contract IDs for a customer](https://developers.appstle.com/subscription-admin-api/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 fo…
- [Get customer details with subscriptions](https://developers.appstle.com/subscription-admin-api/customers/get-customer-details-with-subscriptions.md): Retrieves comprehensive customer information including their subscription contracts. This endpoint p…
- [Get all product swaps for a shop](https://developers.appstle.com/subscription-admin-api/product-catalog/get-all-product-swaps-for-a-shop.md): Retrieves all configured product swap automations for the authenticated shop. Product swaps allow au…
- [Update an existing product swap automation](https://developers.appstle.com/subscription-admin-api/product-catalog/update-an-existing-product-swap-automation.md): Updates an existing product swap automation rule for the authenticated shop. Use this endpoint to mo…
- [Create a new product swap automation](https://developers.appstle.com/subscription-admin-api/product-catalog/create-a-new-product-swap-automation.md): Creates a new product swap automation rule for the authenticated shop. Product swaps automatically r…
- [Get product swap variant groups for a contract](https://developers.appstle.com/subscription-admin-api/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 cont…
- [Get a specific product swap by ID](https://developers.appstle.com/subscription-admin-api/product-catalog/get-a-specific-product-swap-by-id.md): Retrieves detailed information about a specific product swap automation configuration. This endpoint…
- [Delete a product swap automation](https://developers.appstle.com/subscription-admin-api/product-catalog/delete-a-product-swap-automation.md): Permanently deletes a product swap automation configuration. Once deleted, the swap will no longer b…
- [List quick checkout links](https://developers.appstle.com/subscription-admin-api/subscription-management/list-quick-checkout-links.md)
- [Get subscription contract analytics and revenue metrics](https://developers.appstle.com/subscription-admin-api/subscription-management/get-subscription-contract-analytics-and-revenue-metrics.md): Retrieves comprehensive analytics for a specific subscription contract, including total revenue gene…
- [Get available billing intervals for selling plan(s)](https://developers.appstle.com/subscription-admin-api/subscription-management/get-available-billing-intervals-for-selling-plans.md): Retrieves all available billing frequency options configured for specific Shopify selling plan(s). R…
- [Create a new subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/create-a-new-subscription-contract.md): Creates a new subscription contract for a customer with specified products, billing frequency, and d…
- [Get current billing cycle number for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 re…
- [Replace product variants in a subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/replace-product-variants-in-a-subscription-contract.md): Replaces existing product variants with new ones in a subscription contract. This endpoint supports…
- [Split or duplicate an existing subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/split-or-duplicate-an-existing-subscription-contract.md): Creates a new subscription contract by either splitting (moving) or duplicating selected line items…
- [Get subscription fulfillment details for latest order](https://developers.appstle.com/subscription-admin-api/subscription-management/get-subscription-fulfillment-details-for-latest-order.md): Retrieves fulfillment information for the most recent successful order associated with a subscriptio…
- [Update delivery interval for a subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/update-delivery-interval-for-a-subscription-contract.md): Updates the delivery interval for the specified subscription contract. This endpoint allows external…
- [Update subscription delivery method](https://developers.appstle.com/subscription-admin-api/subscription-management/update-subscription-delivery-method.md): Updates the delivery method for a subscription contract, supporting standard shipping, local deliver…
- [Update delivery price for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 manua…
- [Update maximum cycles for a subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/update-maximum-cycles-for-a-subscription-contract.md): Updates the maximum number of billing cycles (orders) after which a subscription will automatically…
- [Update minimum cycles for a subscription contract](https://developers.appstle.com/subscription-admin-api/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…
- [Update order note for subscription](https://developers.appstle.com/subscription-admin-api/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…
- [Update subscription delivery address and method](https://developers.appstle.com/subscription-admin-api/subscription-management/update-subscription-delivery-address-and-method.md): Updates the shipping address or delivery method for a subscription contract. Supports standard shipp…
- [Update subscription contract status](https://developers.appstle.com/subscription-admin-api/subscription-management/update-subscription-contract-status.md): Updates the status of a subscription contract to ACTIVE, PAUSED, or CANCELLED. This endpoint manages…
- [Get raw Shopify GraphQL contract response](https://developers.appstle.com/subscription-admin-api/subscription-management/get-raw-shopify-graphql-contract-response.md): Retrieves the complete, unprocessed subscription contract data directly from Shopify's GraphQL API.…
- [Update custom attributes on a subscription contract](https://developers.appstle.com/subscription-admin-api/subscription-management/update-custom-attributes-on-a-subscription-contract.md): Updates or replaces custom key-value attributes on a subscription contract. These attributes are sto…
- [Update subscription billing attempt](https://developers.appstle.com/subscription-admin-api/billing-&-payments/update-subscription-billing-attempt.md): Updates an existing subscription billing attempt. This endpoint allows modification of billing attem…
- [Update order note for a billing attempt](https://developers.appstle.com/subscription-admin-api/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 or…
- [Trigger immediate billing for an order](https://developers.appstle.com/subscription-admin-api/billing-&-payments/trigger-immediate-billing-for-an-order.md): Immediately processes a billing attempt, creating an order in Shopify. This bypasses the scheduled b…
- [Get past orders](https://developers.appstle.com/subscription-admin-api/billing-&-payments/get-past-orders.md): Retrieves paginated list of past (processed) billing attempts for a subscription contract or custome…
- [Get past orders report with detailed filtering](https://developers.appstle.com/subscription-admin-api/billing-&-payments/get-past-orders-report-with-detailed-filtering.md): Retrieves a detailed report of past billing attempts with advanced filtering options. This endpoint…
- [Reschedule a billing attempt to a new date](https://developers.appstle.com/subscription-admin-api/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…
- [Skip a specific order](https://developers.appstle.com/subscription-admin-api/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…
- [Skip the next upcoming order for a subscription](https://developers.appstle.com/subscription-admin-api/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 a…
- [Get upcoming orders (top orders)](https://developers.appstle.com/subscription-admin-api/billing-&-payments/get-upcoming-orders-top-orders.md): Retrieves upcoming (queued) billing attempts for a subscription contract or customer. Returns the ne…
- [Unskip a previously skipped order](https://developers.appstle.com/subscription-admin-api/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…
- [Add product with custom price to subscription](https://developers.appstle.com/subscription-admin-api/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…
- [Add product to subscription](https://developers.appstle.com/subscription-admin-api/subscription-products/add-product-to-subscription.md): Adds a new product line item to an existing subscription contract. Can add either recurring products…
- [Add multiple products to subscription](https://developers.appstle.com/subscription-admin-api/subscription-products/add-multiple-products-to-subscription.md): Adds multiple product line items to an existing subscription contract in a single request. This batc…
- [Remove product from subscription](https://developers.appstle.com/subscription-admin-api/subscription-products/remove-product-from-subscription.md): Removes a specific product line item from an existing subscription contract. Can optionally retain p…
- [Remove multiple products from subscription](https://developers.appstle.com/subscription-admin-api/subscription-products/remove-multiple-products-from-subscription.md): Removes multiple product line items from an existing subscription contract in a single request. Prod…
- [Update multiple properties of a subscription line item](https://developers.appstle.com/subscription-admin-api/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…
- [Update product line item price](https://developers.appstle.com/subscription-admin-api/subscription-products/update-product-line-item-price.md): Updates the base price of a specific product line item within a subscription contract. This endpoint…
- [Update line item pricing policy with cycle-based discounts](https://developers.appstle.com/subscription-admin-api/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 succe…
- [Update product line item quantity in subscription](https://developers.appstle.com/subscription-admin-api/subscription-products/update-product-line-item-quantity-in-subscription.md): Updates the quantity of a specific product line item within a subscription contract. This comprehens…
- [Update selling plan for a subscription line item](https://developers.appstle.com/subscription-admin-api/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. Se…
- [Get all one-time products for a subscription contract](https://developers.appstle.com/subscription-admin-api/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 al…
- [Add one-time product to subscription order](https://developers.appstle.com/subscription-admin-api/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…
- [Remove one-time product from subscription order](https://developers.appstle.com/subscription-admin-api/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 del…
- [Get one-time products for next upcoming order](https://developers.appstle.com/subscription-admin-api/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 con…
- [Update subscription payment method](https://developers.appstle.com/subscription-admin-api/subscription-payments/update-subscription-payment-method.md): Updates the payment method for an existing subscription contract to use a different existing payment…
- [Send payment method update email to customer](https://developers.appstle.com/subscription-admin-api/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 pa…
- [Get all subscription groups](https://developers.appstle.com/subscription-admin-api/subscription-plans/get-all-subscription-groups.md): Retrieves a list of all subscription groups (selling plan groups) configured in the store. This endp…
- [Update subscription group details and product assignments](https://developers.appstle.com/subscription-admin-api/subscription-plans/update-subscription-group-details-and-product-assignments.md): Updates an existing subscription group (selling plan group) including its name, selling plans config…
- [Create a new subscription group (selling plan group)](https://developers.appstle.com/subscription-admin-api/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…
- [Get all selling plans across all subscription groups](https://developers.appstle.com/subscription-admin-api/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 endp…
- [Remove products or variants from ALL subscription groups](https://developers.appstle.com/subscription-admin-api/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 powe…
- [Get subscription group by ID](https://developers.appstle.com/subscription-admin-api/subscription-plans/get-subscription-group-by-id.md): Retrieves detailed information about a specific subscription group (selling plan group) by its ID. T…
- [Add products or variants to an existing subscription group](https://developers.appstle.com/subscription-admin-api/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 gr…
- [Bulk add products or variants to an existing subscription group](https://developers.appstle.com/subscription-admin-api/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…
- [Remove products or variants from a subscription group](https://developers.appstle.com/subscription-admin-api/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).…
- [Get backup payment recovery opt-in status](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-backup-payment-recovery-opt-in-status.md)
- [Update backup payment recovery opt-in status](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/update-backup-payment-recovery-opt-in-status.md)
- [Update subscription billing attempt](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/update-subscription-billing-attempt.md): Updates an existing subscription billing attempt. This endpoint allows modification of billing attem…
- [Trigger immediate billing for an order](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/trigger-immediate-billing-for-an-order.md): Immediately processes a billing attempt, creating an order in Shopify. This bypasses the scheduled b…
- [Recover a billing attempt stuck in progress](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/recover-a-billing-attempt-stuck-in-progress.md)
- [Get past orders](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-past-orders.md): Retrieves paginated list of past (processed) billing attempts for a subscription contract or custome…
- [Get past orders report with detailed filtering](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-past-orders-report-with-detailed-filtering.md): Retrieves a detailed report of past billing attempts with advanced filtering options. This endpoint…
- [Process refund for subscription order](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/process-refund-for-subscription-order.md): Processes a refund for a fulfilled subscription order. This creates a refund in Shopify and returns…
- [Calculate refund amount preview](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/calculate-refund-amount-preview.md): Calculates the refund amount that would be issued if a specific subscription order fulfillment were…
- [Reschedule a billing attempt to a new date](https://developers.appstle.com/subscription-storefront-api/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…
- [Retry a failed billing attempt](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/retry-a-failed-billing-attempt.md)
- [Get URL for 3DS / SCA security challenge](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-url-for-3ds-sca-security-challenge.md)
- [Skip a failed billing attempt's order](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/skip-a-failed-billing-attempts-order.md)
- [Skip a specific order](https://developers.appstle.com/subscription-storefront-api/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…
- [Skip the next upcoming order for a subscription](https://developers.appstle.com/subscription-storefront-api/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 a…
- [Get upcoming orders (top orders)](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-upcoming-orders-top-orders.md): Retrieves upcoming (queued) billing attempts for a subscription contract or customer. Returns the ne…
- [Unskip a previously skipped order](https://developers.appstle.com/subscription-storefront-api/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…
- [Get subscription payment info for a contract](https://developers.appstle.com/subscription-storefront-api/billing-&-payments/get-subscription-payment-info-for-a-contract.md)
- [List discount rules applicable to bundles](https://developers.appstle.com/subscription-storefront-api/product-catalog/list-discount-rules-applicable-to-bundles.md)
- [Get variant data for a list of variant IDs](https://developers.appstle.com/subscription-storefront-api/product-catalog/get-variant-data-for-a-list-of-variant-ids.md)
- [Get product swap variant groups for a contract](https://developers.appstle.com/subscription-storefront-api/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 cont…
- [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/subscription-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md)
- [List applicable customer portal campaigns](https://developers.appstle.com/subscription-storefront-api/campaigns/list-applicable-customer-portal-campaigns.md)
- [Get campaign landing details](https://developers.appstle.com/subscription-storefront-api/campaigns/get-campaign-landing-details.md)
- [Redeem a campaign offer](https://developers.appstle.com/subscription-storefront-api/campaigns/redeem-a-campaign-offer.md)
- [Track a campaign banner event](https://developers.appstle.com/subscription-storefront-api/campaigns/track-a-campaign-banner-event.md)
- [Get subscriptionscpapicancellation flowspublished](https://developers.appstle.com/subscription-storefront-api/cancellation-flow-customer-portal-resource/get-subscriptionscpapicancellation-flowspublished.md)
- [Get cancellation management configuration](https://developers.appstle.com/subscription-storefront-api/customer-retention/get-cancellation-management-configuration.md)
- [Record a customer retention activity](https://developers.appstle.com/subscription-storefront-api/customer-retention/record-a-customer-retention-activity.md)
- [Get win-back offer landing details](https://developers.appstle.com/subscription-storefront-api/customer-retention/get-win-back-offer-landing-details.md)
- [Reactivate a subscription from a win-back offer](https://developers.appstle.com/subscription-storefront-api/customer-retention/reactivate-a-subscription-from-a-win-back-offer.md)
- [Execute a configured cancellation retention offer and record the retention activity](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/execute-a-configured-cancellation-retention-offer-and-record-the-retention-activity.md)
- [Get currently logged-in customer ID](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-currently-logged-in-customer-id.md): Returns the customer ID of the currently authenticated customer from their Shopify session. This end…
- [Skip or unskip a product line item for next order](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/skip-or-unskip-a-product-line-item-for-next-order.md)
- [Update subscription contract details](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-subscription-contract-details.md)
- [Get current billing cycle for a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-current-billing-cycle-for-a-subscription-contract.md)
- [Get order note for a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-order-note-for-a-subscription-contract.md)
- [Merge an existing contract into another](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/merge-an-existing-contract-into-another.md)
- [Replace contract variants in bulk (v2)](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/replace-contract-variants-in-bulk-v2.md)
- [Get current customer's saved Shopify payment methods](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-current-customers-saved-shopify-payment-methods.md)
- [Reschedule a planned subscription fulfillment](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/reschedule-a-planned-subscription-fulfillment.md)
- [List Shopify fulfillments for a specific order](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-specific-order.md)
- [List Shopify fulfillments for a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/list-shopify-fulfillments-for-a-subscription-contract.md)
- [Swap a product within a Build-a-Box subscription](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/swap-a-product-within-a-build-a-box-subscription.md)
- [Get subscription contract as a flattened map](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-subscription-contract-as-a-flattened-map.md)
- [Apply a discount code to a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/apply-a-discount-code-to-a-subscription-contract.md)
- [Apply a cancellation-flow discount to a contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/apply-a-cancellation-flow-discount-to-a-contract.md)
- [Edit custom attributes on a single line item](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/edit-custom-attributes-on-a-single-line-item.md)
- [Email customer portal magic link to subscriber](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/email-customer-portal-magic-link-to-subscriber.md)
- [Update freeze (skip-billing) status on a contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-freeze-skip-billing-status-on-a-contract.md)
- [Check whether anchor day overwrite is enabled](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/check-whether-anchor-day-overwrite-is-enabled.md)
- [Update product-level custom attributes on a contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-product-level-custom-attributes-on-a-contract.md)
- [Remove a discount from a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/remove-a-discount-from-a-subscription-contract.md)
- [Remove a line item from a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/remove-a-line-item-from-a-subscription-contract.md)
- [Update next billing date for a subscription contract](https://developers.appstle.com/subscription-storefront-api/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 c…
- [Update billing interval for a subscription contract](https://developers.appstle.com/subscription-storefront-api/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…
- [Update delivery method on a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-delivery-method-on-a-subscription-contract.md)
- [Set existing Shopify payment method on contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/set-existing-shopify-payment-method-on-contract.md)
- [Change contract frequency by selecting a compatible selling-plan frequency](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-compatible-selling-plan-frequency.md)
- [Change contract frequency by selecting a new selling plan](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/change-contract-frequency-by-selecting-a-new-selling-plan.md)
- [Update custom attributes on contract line items](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-custom-attributes-on-contract-line-items.md)
- [Update line item quantity on a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-line-item-quantity-on-a-subscription-contract.md)
- [Update order note on a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-order-note-on-a-subscription-contract.md)
- [Trigger payment method re-collection email](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/trigger-payment-method-re-collection-email.md)
- [Get raw Shopify subscription contract (external view)](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract-external-view.md)
- [Get raw Shopify subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-raw-shopify-subscription-contract.md)
- [Sync shipping price on contract from delivery profile](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/sync-shipping-price-on-contract-from-delivery-profile.md)
- [Cancel and delete a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/cancel-and-delete-a-subscription-contract.md)
- [Get current customer's subscription profile](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-current-customers-subscription-profile.md)
- [Get valid subscription contracts for a customer](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/get-valid-subscription-contracts-for-a-customer.md)
- [List a customer's valid subscription contract IDs](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/list-a-customers-valid-subscription-contract-ids.md)
- [Update line item quantities for a classic Build-a-Box subscription](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-line-item-quantities-for-a-classic-build-a-box-subscription.md)
- [Update subscription contract order note](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/update-subscription-contract-order-note.md)
- [Add a line item to a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-subscription-contract.md)
- [Add a line item to a specific section of a contract](https://developers.appstle.com/subscription-storefront-api/subscription-contracts/add-a-line-item-to-a-specific-section-of-a-contract.md)
- [Proxy GraphQL queries to Shopify Customer Account API](https://developers.appstle.com/subscription-storefront-api/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 custo…
- [Initiate Customer Account API OAuth flow](https://developers.appstle.com/subscription-storefront-api/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…
- [Logout from Customer Account API](https://developers.appstle.com/subscription-storefront-api/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 cus…
- [Handle OAuth callback from Shopify](https://developers.appstle.com/subscription-storefront-api/customer-portal/handle-oauth-callback-from-shopify.md): OAuth 2.0 callback endpoint that receives the authorization code from Shopify after customer authori…
- [Check Customer Account API authentication status](https://developers.appstle.com/subscription-storefront-api/customer-portal/check-customer-account-api-authentication-status.md): Checks whether the current customer has valid Customer Account API tokens stored. Used by the custom…
- [Get shop info for the currently signed-in shop](https://developers.appstle.com/subscription-storefront-api/customer-portal/get-shop-info-for-the-currently-signed-in-shop.md)
- [Get customer portal settings](https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-settings.md): Retrieves the customer portal configuration and settings for the authenticated shop. The customer po…
- [Get customer portal label translations for locale](https://developers.appstle.com/subscription-storefront-api/customization/get-customer-portal-label-translations-for-locale.md)
- [Get shop customization CSS by category](https://developers.appstle.com/subscription-storefront-api/customization/get-shop-customization-css-by-category.md)
- [Get custom CSS for customer portal](https://developers.appstle.com/subscription-storefront-api/customization/get-custom-css-for-customer-portal.md): Retrieves the custom CSS styling configuration for the customer portal. This endpoint returns all cu…
- [Get widget label translations for locale](https://developers.appstle.com/subscription-storefront-api/customization/get-widget-label-translations-for-locale.md)
- [Get delivery options for subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-delivery-options-for-subscription-contract.md): Retrieves all valid delivery methods available for a specific subscription contract. Returns shippin…
- [Get single product data by ID](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-single-product-data-by-id.md): Retrieves detailed information for a specific product by its Shopify product ID. Returns complete pr…
- [List product handles for the shop](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-product-handles-for-the-shop.md)
- [Get products data with pagination](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-products-data-with-pagination.md): Retrieves paginated product catalog data from Shopify, optionally filtered by search term, selling p…
- [Get selling plans for products](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-selling-plans-for-products.md): Retrieves all selling plans (subscription plans) associated with a set of products. This endpoint is…
- [Search subscription-enabled products with pagination](https://developers.appstle.com/subscription-storefront-api/subscription-data/search-subscription-enabled-products-with-pagination.md)
- [List subscription products filtered by selling plans](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-subscription-products-filtered-by-selling-plans.md)
- [List delivery options available for the shop](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-delivery-options-available-for-the-shop.md)
- [List subscription products available to the customer](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-subscription-products-available-to-the-customer.md)
- [Get compatible selling-plan frequencies](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-compatible-selling-plan-frequencies.md): Get compatible selling-plan frequency options for a subscription contract
- [List products with their selling plans (v2)](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-products-with-their-selling-plans-v2.md)
- [Get variant contextual pricing](https://developers.appstle.com/subscription-storefront-api/subscription-data/get-variant-contextual-pricing.md): Retrieves contextual pricing information for a product variant based on currency and country. This e…
- [List saved addresses for the current customer](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-saved-addresses-for-the-current-customer.md)
- [List supported shipping countries](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-supported-shipping-countries.md)
- [List enabled presentment currencies for the shop](https://developers.appstle.com/subscription-storefront-api/subscription-data/list-enabled-presentment-currencies-for-the-shop.md)
- [List delivery profile locations](https://developers.appstle.com/subscription-storefront-api/delivery-&-shipping/list-delivery-profile-locations.md)
- [Get a page of order events (paginated)](https://developers.appstle.com/subscription-storefront-api/delivery-&-shipping/get-a-page-of-order-events-paginated.md)
- [Get the live fulfillment status for an order](https://developers.appstle.com/subscription-storefront-api/delivery-&-shipping/get-the-live-fulfillment-status-for-an-order.md)
- [Get customer loyalty points and rewards data](https://developers.appstle.com/subscription-storefront-api/loyalty-integration/get-customer-loyalty-points-and-rewards-data.md): Retrieves the loyalty/rewards program data for the currently logged-in customer. This includes point…
- [Get available ways to earn loyalty points](https://developers.appstle.com/subscription-storefront-api/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 show…
- [Redeem loyalty points for a reward](https://developers.appstle.com/subscription-storefront-api/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 f…
- [Get available loyalty point redemption options](https://developers.appstle.com/subscription-storefront-api/loyalty-integration/get-available-loyalty-point-redemption-options.md): Returns all available rewards that the customer can redeem their loyalty points for. This shows cust…
- [List eligible pickup dates](https://developers.appstle.com/subscription-storefront-api/store-pickup/list-eligible-pickup-dates.md)
- [Get the first eligible pickup date](https://developers.appstle.com/subscription-storefront-api/store-pickup/get-the-first-eligible-pickup-date.md)
- [List eligible pickup times for a date](https://developers.appstle.com/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date.md)
- [List eligible pickup times for a date](https://developers.appstle.com/subscription-storefront-api/store-pickup/list-eligible-pickup-times-for-a-date-1.md)
- [List available pickup locations](https://developers.appstle.com/subscription-storefront-api/store-pickup/list-available-pickup-locations.md)
- [Update pickup and delivery details on a subscription contract](https://developers.appstle.com/subscription-storefront-api/store-pickup/update-pickup-and-delivery-details-on-a-subscription-contract.md)
- [Execute a server-authoritative next-order delay](https://developers.appstle.com/subscription-storefront-api/subscription-actions/execute-a-server-authoritative-next-order-delay.md): Re-reads the recorded billing attempt, recomputes delayDays 7 or 14 in the shop IANA timezone, re-ru…
- [Preview a server-authoritative next-order delay](https://developers.appstle.com/subscription-storefront-api/subscription-actions/preview-a-server-authoritative-next-order-delay.md): Accepts contractId, optional billingAttemptId, and delayDays 7 or 14. Returns shop-local current and…
- [Get subscription bundle settings by ID](https://developers.appstle.com/subscription-storefront-api/build-a-box-&-bundles/get-subscription-bundle-settings-by-id.md)
- [Get a subscription bundling configuration by token](https://developers.appstle.com/subscription-storefront-api/build-a-box-&-bundles/get-a-subscription-bundling-configuration-by-token.md)
- [List single-product Build-a-Box bundlings for the shop](https://developers.appstle.com/subscription-storefront-api/build-a-box-&-bundles/list-single-product-build-a-box-bundlings-for-the-shop.md)
- [Get public Build-a-Box bundle details by handle (v3)](https://developers.appstle.com/subscription-storefront-api/build-a-box-&-bundles/get-public-build-a-box-bundle-details-by-handle-v3.md)
- [Replace product variants in a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-management/replace-product-variants-in-a-subscription-contract.md): Replaces existing product variants with new ones in a subscription contract. This endpoint supports…
- [Split or duplicate an existing subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-management/split-or-duplicate-an-existing-subscription-contract.md): Creates a new subscription contract by either splitting (moving) or duplicating selected line items…
- [Update subscription delivery address and method](https://developers.appstle.com/subscription-storefront-api/subscription-management/update-subscription-delivery-address-and-method.md): Updates the shipping address or delivery method for a subscription contract. Supports standard shipp…
- [Update subscription contract status](https://developers.appstle.com/subscription-storefront-api/subscription-management/update-subscription-contract-status.md): Updates the status of a subscription contract to ACTIVE, PAUSED, or CANCELLED. This endpoint manages…
- [Update custom attributes on a subscription contract](https://developers.appstle.com/subscription-storefront-api/subscription-management/update-custom-attributes-on-a-subscription-contract.md): Updates or replaces custom key-value attributes on a subscription contract. These attributes are sto…
- [List one-time add-on products for a contract](https://developers.appstle.com/subscription-storefront-api/subscription-one-time-products/list-one-time-add-on-products-for-a-contract.md)
- [Save a one-time add-on for a billing attempt](https://developers.appstle.com/subscription-storefront-api/subscription-one-time-products/save-a-one-time-add-on-for-a-billing-attempt.md)
- [Delete a one-time add-on from a billing attempt](https://developers.appstle.com/subscription-storefront-api/subscription-one-time-products/delete-a-one-time-add-on-from-a-billing-attempt.md)
- [Update quantity of a one-time add-on](https://developers.appstle.com/subscription-storefront-api/subscription-one-time-products/update-quantity-of-a-one-time-add-on.md)
- [Get one-time add-ons for the next upcoming order](https://developers.appstle.com/subscription-storefront-api/subscription-one-time-products/get-one-time-add-ons-for-the-next-upcoming-order.md)
- [List all selling plans available to the customer](https://developers.appstle.com/subscription-storefront-api/subscription-plans/list-all-selling-plans-available-to-the-customer.md)
- [Get subscriptionscpapiupcoming order rewards](https://developers.appstle.com/subscription-storefront-api/upcoming-order-reward-resource/get-subscriptionscpapiupcoming-order-rewards.md)
- [Appstle Subscriptions frequently asked questions](https://developers.appstle.com/subscription/faq.md): Answers to common questions about widget customization, detecting subscription orders, customer port…
- [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 ref…
- [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 ma…
- [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 point…
- [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 manageme…
- [Automate loyalty with Shopify Flow](https://developers.appstle.com/loyalty/shopify-flow.md): Automate loyalty with Appstle's native Shopify Flow triggers and actions. Award points, assign VIP t…
- [Shopify metafields and tags for Appstle Loyalty](https://developers.appstle.com/loyalty/metafields-and-tags.md): Shopify metafields and tags set by Appstle Loyalty: loyalty profiles, reward codes, product reviews,…
- [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 — ho…
- [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 to…
- [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…
- [Add store credits to customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/add-store-credits-to-customer-account.md)
- [Add points to customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/add-points-to-customer-account.md)
- [Approve pending point transactions](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/approve-pending-point-transactions.md)
- [Get all point earning rules](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-all-point-earning-rules.md)
- [Get customer point transaction history](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-customer-point-transaction-history.md)
- [Remove points from customer account](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/remove-points-from-customer-account.md)
- [Get top customers by points earned](https://developers.appstle.com/loyalty-admin-api/points-&-earn-rules/get-top-customers-by-points-earned.md)
- [Check discount code validity](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/check-discount-code-validity.md)
- [Get all point redemption rules](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/get-all-point-redemption-rules.md)
- [Redeem customer points for rewards](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/redeem-customer-points-for-rewards.md)
- [Update discount code status](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/update-discount-code-status.md)
- [Update discount code status (legacy endpoint)](https://developers.appstle.com/loyalty-admin-api/redemptions-&-discount-codes/update-discount-code-status-legacy-endpoint.md)
- [Get customer loyalty details](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/get-customer-loyalty-details.md)
- [Enroll customer in loyalty program](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/enroll-customer-in-loyalty-program.md)
- [Update customer birth date](https://developers.appstle.com/loyalty-admin-api/customer-enrollment-&-profile/update-customer-birth-date.md)
- [List storefront widget label translations](https://developers.appstle.com/loyalty-admin-api/storefront-widgets-&-labels/list-storefront-widget-label-translations.md)
- [Generate customer referral URL](https://developers.appstle.com/loyalty-storefront-api/referrals/generate-customer-referral-url.md)
- [Get customer referral history](https://developers.appstle.com/loyalty-storefront-api/referrals/get-customer-referral-history.md)
- [Accept referral offer (GET)](https://developers.appstle.com/loyalty-storefront-api/referrals/accept-referral-offer-get.md)
- [Accept referral offer (POST)](https://developers.appstle.com/loyalty-storefront-api/referrals/accept-referral-offer-post.md)
- [Send customer referral email](https://developers.appstle.com/loyalty-storefront-api/referrals/send-customer-referral-email.md)
- [Claim social media reward points](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/claim-social-media-reward-points.md)
- [Track customer store visit](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/track-customer-store-visit.md)
- [Get customer point transaction history](https://developers.appstle.com/loyalty-storefront-api/points-&-earn-rules/get-customer-point-transaction-history.md)
- [Get customer loyalty information](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/get-customer-loyalty-information.md)
- [Enable loyalty program for customer](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/enable-loyalty-program-for-customer.md)
- [Enroll customer in loyalty program](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/enroll-customer-in-loyalty-program.md)
- [Get logged-in customer ID](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/get-logged-in-customer-id.md)
- [Sync customer metafield data](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/sync-customer-metafield-data.md)
- [Update customer birth date](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/update-customer-birth-date.md)
- [Update customer loyalty status](https://developers.appstle.com/loyalty-storefront-api/customer-enrollment-&-profile/update-customer-loyalty-status.md)
- [Get product reviews by product ID](https://developers.appstle.com/loyalty-storefront-api/reviews/get-product-reviews-by-product-id.md)
- [Submit product review](https://developers.appstle.com/loyalty-storefront-api/reviews/submit-product-review.md)
- [Redeem customer loyalty points](https://developers.appstle.com/loyalty-storefront-api/redemptions-&-discount-codes/redeem-customer-loyalty-points.md)
- [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/loyalty-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md)
- [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 ga…
- [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 ke…
- [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 custom…
- [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, ac…
- [Automate memberships with Shopify Flow](https://developers.appstle.com/memberships/shopify-flow.md): Automate membership workflows with Appstle's Shopify Flow triggers: tag customers, send emails, and…
- [Shopify metafields and tags for Appstle Memberships](https://developers.appstle.com/memberships/metafields-and-tags.md): Shopify metafields and tags set by Appstle Memberships — what they contain, when they update, and ho…
- [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…
- [Partner Integration Framework](https://developers.appstle.com/memberships/partner-integration.md): Build a seamless, zero-configuration integration between your app and Appstle Memberships using scop…
- [Appstle Memberships webhook events and setup](https://developers.appstle.com/memberships/webhooks.md): Receive real-time membership lifecycle and billing event notifications via webhooks. Covers Svix sig…
- [Get cancellation flow configuration](https://developers.appstle.com/memberships-admin-api/cancellation-flow-configuration/get-cancellation-flow-configuration.md): Retrieves the cancellation management settings for the shop, controlling how members cancel subscrip…
- [Get past discount codes for contract](https://developers.appstle.com/memberships-admin-api/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 memb…
- [Get customer payment token information](https://developers.appstle.com/memberships-admin-api/customer-payment-methods/get-customer-payment-token-information.md): Retrieves payment method token information for a specific customer. This endpoint returns the custom…
- [Get customer portal settings](https://developers.appstle.com/memberships-admin-api/customer-portal-configuration/get-customer-portal-settings.md): Retrieves customer portal configuration settings for the authenticated shop. These settings control…
- [Generate customer portal authentication token](https://developers.appstle.com/memberships-admin-api/membership-contracts/generate-customer-portal-authentication-token.md): Generates an authentication token for customer portal access using either customer ID or email addre…
- [Generate customer portal magic link](https://developers.appstle.com/memberships-admin-api/membership-contracts/generate-customer-portal-magic-link.md): Generates a secure, time-limited magic link that allows customers to access and manage their subscri…
- [Add product line item to subscription contract](https://developers.appstle.com/memberships-admin-api/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 mercha…
- [Get membership/subscription contract list](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-membershipsubscription-contract-list.md): Retrieves a paginated list of membership/subscription contracts with advanced filtering capabilities…
- [Get billing interval options for selling plans](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-billing-interval-options-for-selling-plans.md): Retrieves available billing frequency/interval options for specified Shopify selling plans (subscrip…
- [Get customer payment methods](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-customer-payment-methods.md): Retrieves available Shopify payment methods for a specific customer from the customer portal.
- [Get subscription order fulfillment details](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-subscription-order-fulfillment-details.md): Retrieves fulfillment information for the most recent order generated by a subscription contract. Sh…
- [Get pending downgrade for a subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-pending-downgrade-for-a-subscription-contract.md): Retrieves the pending/scheduled downgrade details for a specific subscription contract. This endpoin…
- [Cancel pending downgrade for a subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/cancel-pending-downgrade-for-a-subscription-contract.md): Cancels a scheduled/pending downgrade for a specific subscription contract. This endpoint removes th…
- [Update product variant in subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-product-variant-in-subscription-contract.md): Replaces an existing product variant with a new variant in a subscription contract. This allows cust…
- [Create and add custom discount to subscription](https://developers.appstle.com/memberships-admin-api/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 cre…
- [Add product to recurring subscription](https://developers.appstle.com/memberships-admin-api/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 in…
- [Apply discount code to subscription](https://developers.appstle.com/memberships-admin-api/membership-contracts/apply-discount-code-to-subscription.md): Applies an existing Shopify discount code to a subscription contract. The discount code must already…
- [Send customer portal magic link via email](https://developers.appstle.com/memberships-admin-api/membership-contracts/send-customer-portal-magic-link-via-email.md): Automatically generates and emails a secure magic link to the customer for accessing their subscript…
- [Remove discount from subscription](https://developers.appstle.com/memberships-admin-api/membership-contracts/remove-discount-from-subscription.md): Removes a discount from a subscription contract. This endpoint allows you to remove previously appli…
- [Remove product from recurring subscription](https://developers.appstle.com/memberships-admin-api/membership-contracts/remove-product-from-recurring-subscription.md): Removes a line item (product) from a subscription contract. The product will no longer be included i…
- [Update subscription contract billing date](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-subscription-contract-billing-date.md): Updates the next billing date for a subscription contract. This reschedules when the next payment wi…
- [Update billing interval for subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-billing-interval-for-subscription-contract.md): Changes the billing frequency of a subscription contract. This allows customers to modify how often…
- [Update custom note attributes on subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-custom-note-attributes-on-subscription-contract.md): Updates custom note attributes (key-value pairs) on a subscription contract. These attributes are st…
- [Update delivery interval for subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-delivery-interval-for-subscription-contract.md): Changes the delivery/shipping frequency of a subscription contract. This allows customers to modify…
- [Update subscription line item quantity and pricing](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-subscription-line-item-quantity-and-pricing.md): Updates an existing line item in a subscription contract, modifying quantity, variant, or price. Thi…
- [Update custom attributes on subscription line item](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-custom-attributes-on-subscription-line-item.md): Updates custom attributes (metadata) on a specific subscription line item. Attributes allow storing…
- [Update maximum billing cycles for subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-maximum-billing-cycles-for-subscription-contract.md): Sets the maximum number of billing cycles (payments) after which the subscription will automatically…
- [Update minimum billing cycles for subscription contract](https://developers.appstle.com/memberships-admin-api/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 sub…
- [Update order note/instructions for subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-order-noteinstructions-for-subscription-contract.md): Updates the persistent order note attached to a subscription contract. This note is automatically in…
- [Update subscription payment method](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-subscription-payment-method.md): Updates the payment method for a subscription contract by refreshing payment instrument from Shopify…
- [Update shipping address for subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-shipping-address-for-subscription-contract.md): Changes the delivery shipping address for a subscription contract. This allows customers to update w…
- [Update subscription contract status (pause/resume/activate)](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-subscription-contract-status-pauseresumeactivate.md): Changes the status of a subscription contract. This allows pausing, resuming, or activating subscrip…
- [Get raw subscription contract details from Shopify](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-raw-subscription-contract-details-from-shopify.md): Retrieves the complete subscription contract data directly from Shopify's GraphQL API. This returns…
- [Cancel membership/subscription contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/cancel-membershipsubscription-contract.md): Cancels a membership/subscription contract and sends cancellation confirmation emails. This endpoint…
- [Get detailed customer subscription information](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-detailed-customer-subscription-information.md): Retrieves comprehensive details for all subscription contracts associated with a specific customer.…
- [Sync customer information](https://developers.appstle.com/memberships-admin-api/membership-contracts/sync-customer-information.md): Triggers synchronization of customer information from Shopify for the specified customer ID.
- [Get valid subscription contract IDs for customer](https://developers.appstle.com/memberships-admin-api/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…
- [Get subscription customer details](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-subscription-customer-details.md): Retrieves comprehensive customer information from Shopify for a specific customer ID. This endpoint…
- [Create shipping/delivery profile (V1 format - Legacy)](https://developers.appstle.com/memberships-admin-api/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…
- [Create shipping/delivery profile (V2 format)](https://developers.appstle.com/memberships-admin-api/shipping-&-delivery-profiles/create-shippingdelivery-profile-v2-format.md): Creates a new Shopify delivery profile with custom shipping zones, rates, and methods. Delivery prof…
- [Get product swap options for subscription items](https://developers.appstle.com/memberships-admin-api/product-swap-rules/get-product-swap-options-for-subscription-items.md): Retrieves available product swap/substitution options for specified variants based on configured swa…
- [Update subscription billing attempt](https://developers.appstle.com/memberships-admin-api/billing-&-orders/update-subscription-billing-attempt.md): Updates billing attempt details for a subscription contract. Billing attempts represent individual c…
- [Update order note for billing attempt](https://developers.appstle.com/memberships-admin-api/billing-&-orders/update-order-note-for-billing-attempt.md): Updates the order note/instructions for a specific upcoming billing attempt. These notes are stored…
- [Retry billing for failed attempt](https://developers.appstle.com/memberships-admin-api/billing-&-orders/retry-billing-for-failed-attempt.md): Immediately triggers a billing attempt for a subscription contract, bypassing the normal scheduled b…
- [Get past orders](https://developers.appstle.com/memberships-admin-api/billing-&-orders/get-past-orders.md): Retrieves historical billing attempts including successful, failed, and skipped orders. Returns comp…
- [Get paginated past or upcoming orders report](https://developers.appstle.com/memberships-admin-api/billing-&-orders/get-paginated-past-or-upcoming-orders-report.md): Retrieves a paginated list of subscription billing attempts filtered by status (SUCCESS, FAILURE, QU…
- [Skip upcoming subscription order](https://developers.appstle.com/memberships-admin-api/billing-&-orders/skip-upcoming-subscription-order.md): Skips a scheduled billing attempt, preventing the order from being processed. The next billing date…
- [Get upcoming orders](https://developers.appstle.com/memberships-admin-api/billing-&-orders/get-upcoming-orders.md): Retrieves upcoming/scheduled billing attempts for shop, contract, or customer. Returns future orders…
- [Get bundle settings](https://developers.appstle.com/memberships-admin-api/bundle-settings/get-bundle-settings.md): Retrieves the subscription bundle configuration settings for the authenticated shop. Returns setting…
- [Generate bundle-specific discount code](https://developers.appstle.com/memberships-admin-api/product-bundles/generate-bundle-specific-discount-code.md): Creates a Shopify discount code specifically for a subscription bundle. This endpoint generates uniq…
- [Get bundle details by handle](https://developers.appstle.com/memberships-admin-api/product-bundles/get-bundle-details-by-handle.md): Retrieves detailed information about a subscription product bundle including bundled items, pricing,…
- [Get one-time add-ons for a membership contract](https://developers.appstle.com/memberships-admin-api/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 cont…
- [Add one-time product to upcoming order](https://developers.appstle.com/memberships-admin-api/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.…
- [Remove one-time product from upcoming order](https://developers.appstle.com/memberships-admin-api/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…
- [Get custom CSS styling configuration](https://developers.appstle.com/memberships-admin-api/custom-css-styling/get-custom-css-styling-configuration.md): Retrieves custom CSS styles configured for subscription widgets and customer portal. These styles al…
- [List all membership plan groups](https://developers.appstle.com/memberships-admin-api/membership-plans/list-all-membership-plan-groups.md): Retrieves all membership/subscription plan groups for the authenticated shop, including plan details…
- [Get a membership plan group](https://developers.appstle.com/memberships-admin-api/membership-plans/get-a-membership-plan-group.md): Retrieves a specific membership/subscription plan group by its Shopify selling plan group ID, includ…
- [Get cancellation flow settings](https://developers.appstle.com/memberships-customer-portal-api/cancellation-flow-configuration/get-cancellation-flow-settings.md): Retrieves the cancellation management configuration including retention offers, cancellation reasons…
- [Get past discount history](https://developers.appstle.com/memberships-customer-portal-api/customer-discount-history/get-past-discount-history.md): Retrieves the history of discount codes applied to a customer's subscription contracts.
- [Get customer portal settings](https://developers.appstle.com/memberships-customer-portal-api/customer-portal-configuration/get-customer-portal-settings.md): Retrieves the customer portal configuration including UI customization, text labels, feature toggles…
- [Get customer portal label translations for locale](https://developers.appstle.com/memberships-customer-portal-api/customer-portal-configuration/get-customer-portal-label-translations-for-locale.md)
- [Create retention activity record](https://developers.appstle.com/memberships-customer-portal-api/customer-retention/create-retention-activity-record.md): Records a customer retention activity such as cancellation feedback, retention offer acceptance, or…
- [Get product details by ID](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/get-product-details-by-id.md)
- [Get product with selling plans and variants](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/get-product-with-selling-plans-and-variants.md)
- [Search subscription-enabled products with pagination](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/search-subscription-enabled-products-with-pagination.md)
- [List products attached to selling plans](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/list-products-attached-to-selling-plans.md)
- [Get contextual pricing for a variant by currency](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/get-contextual-pricing-for-a-variant-by-currency.md)
- [Get pickup locations](https://developers.appstle.com/memberships-customer-portal-api/shipping-&-delivery-profiles/get-pickup-locations.md): Retrieves available pickup locations for the customer's subscription delivery.
- [Get loyalty customer details](https://developers.appstle.com/memberships-customer-portal-api/loyalty-integration/get-loyalty-customer-details.md): Retrieves loyalty program details for a customer associated with a specific subscription contract, i…
- [Get loyalty point earn options](https://developers.appstle.com/memberships-customer-portal-api/loyalty-integration/get-loyalty-point-earn-options.md): Retrieves available loyalty point earning campaigns and rules for the shop.
- [Redeem loyalty points](https://developers.appstle.com/memberships-customer-portal-api/loyalty-integration/redeem-loyalty-points.md): Redeems loyalty points for a customer associated with a specific subscription contract using the spe…
- [Get loyalty point redeem options](https://developers.appstle.com/memberships-customer-portal-api/loyalty-integration/get-loyalty-point-redeem-options.md): Retrieves available loyalty point redemption rules and options for the shop.
- [Get product swap options by variant](https://developers.appstle.com/memberships-customer-portal-api/product-swap-rules/get-product-swap-options-by-variant.md): Retrieves available product swap/substitution options for specified variant IDs, allowing customers…
- [Get shop info for current user](https://developers.appstle.com/memberships-customer-portal-api/shop-settings/get-shop-info-for-current-user.md): Retrieves shop information and membership settings for the currently authenticated customer's shop.
- [Update billing attempt](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/update-billing-attempt.md): Updates a subscription billing attempt record from the customer portal.
- [Trigger billing attempt](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/trigger-billing-attempt.md): Triggers an immediate billing attempt for a specific subscription billing record from the customer p…
- [Get past orders](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/get-past-orders.md): Retrieves past order history for a subscription contract from the customer portal.
- [Skip an upcoming billing order](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/skip-an-upcoming-billing-order.md): Skips the next scheduled billing/order for a membership contract. The membership remains active, but…
- [Get upcoming orders](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/get-upcoming-orders.md): Retrieves upcoming/scheduled orders for a subscription contract from the customer portal.
- [Update subscription contract details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-subscription-contract-details.md): Updates an existing subscription contract's details from the customer portal.
- [Get current billing cycle](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-current-billing-cycle.md): Retrieves the current billing cycle number for a specific subscription contract.
- [Get customer subscription details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-customer-subscription-details.md): Retrieves subscription contract customer details and order notes for a specific contract.
- [Get customer payment methods](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-customer-payment-methods.md): Retrieves available Shopify payment methods for a specific customer from the customer portal.
- [List Shopify fulfillments for a subscription contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/list-shopify-fulfillments-for-a-subscription-contract.md)
- [Get pending downgrade](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-pending-downgrade.md): Retrieves pending plan downgrade information for a subscription contract.
- [Cancel pending downgrade](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/cancel-pending-downgrade.md): Cancels a pending plan downgrade for a subscription contract.
- [Update line item variant](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-line-item-variant.md): Updates the product variant for a line item in a subscription contract, allowing customers to swap t…
- [Add a product to an existing membership contract](https://developers.appstle.com/memberships-customer-portal-api/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 customer…
- [Apply discount code](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/apply-discount-code.md): Applies a discount code to a subscription contract from the customer portal.
- [Apply cancellation retention discount](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/apply-cancellation-retention-discount.md): Applies a retention discount to a subscription contract as part of the cancellation flow to retain t…
- [Send magic link email](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/send-magic-link-email.md): Sends a magic link email to the customer for passwordless access to manage their subscription.
- [Remove discount from contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/remove-discount-from-contract.md): Removes an applied discount from a subscription contract from the customer portal.
- [Remove line item from contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/remove-line-item-from-contract.md): Removes a product line item from a subscription contract from the customer portal.
- [Update next billing date](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-next-billing-date.md): Updates the next billing date for a subscription contract from the customer portal.
- [Update billing interval](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-billing-interval.md): Updates the billing frequency interval for a subscription contract from the customer portal.
- [Update existing payment method details](https://developers.appstle.com/memberships-customer-portal-api/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/memberships-customer-portal-api/membership-contracts/update-line-item-attributes.md): Updates custom attributes on a subscription contract line item from the customer portal.
- [Update order note](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-order-note.md): Updates the order note for a subscription contract from the customer portal.
- [Update payment method](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-payment-method.md): Updates the payment method associated with a subscription contract from the customer portal.
- [Update shipping address](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-shipping-address.md): Updates the shipping/delivery address for a subscription contract from the customer portal.
- [Update membership contract status](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-membership-contract-status.md): Updates the status of an existing membership contract (ACTIVE, PAUSED, CANCELLED, or EXPIRED). This…
- [Get raw Shopify subscription contract data](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-raw-shopify-subscription-contract-data.md)
- [Get subscription contract details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-subscription-contract-details.md): Retrieves the raw subscription contract details for a specific contract by ID.
- [Cancel a membership contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/cancel-a-membership-contract.md): Permanently cancels an active membership contract in Shopify. This operation stops all future billin…
- [Get current customer's membership subscription profile](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-current-customers-membership-subscription-profile.md)
- [Get valid subscription contracts for a customer](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-valid-subscription-contracts-for-a-customer.md)
- [List current customer's valid subscription contract IDs](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/list-current-customers-valid-subscription-contract-ids.md)
- [Add line item to contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/add-line-item-to-contract.md): Adds a new product line item to a subscription contract from the customer portal.
- [Get one-off items for contract](https://developers.appstle.com/memberships-customer-portal-api/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…
- [Add or update one-off item](https://developers.appstle.com/memberships-customer-portal-api/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 custom CSS styles](https://developers.appstle.com/memberships-customer-portal-api/custom-css-styling/get-custom-css-styles.md): Retrieves the custom CSS styling configuration for the subscription customer portal and widgets.
- [Get all selling plans](https://developers.appstle.com/memberships-customer-portal-api/membership-plans/get-all-selling-plans.md): Retrieves all available selling plans for the customer portal, used to display plan options to custo…
- [Appstle Bundles: Build-a-Box and Bundle Rules](https://developers.appstle.com/bundles/introduction.md): Appstle Bundles provides Admin and Storefront REST APIs to read bundle rules, power build-a-box expe…
- [Authenticate with the Appstle Bundles API](https://developers.appstle.com/bundles/authentication.md): Create an Appstle API key and pass it in the X-API-Key header for Bundles Admin API requests.
- [Get started with Appstle Bundles API](https://developers.appstle.com/bundles/quickstart.md): Create an API key, read bundle rules, and inspect build-a-box storefront endpoints.
- [Appstle Bundles integration guide](https://developers.appstle.com/bundles/integration-guide.md): Build a production integration with Appstle Bundles. Covers base URLs, authentication, bundle rules,…
- [Build bundles with your own storefront UI](https://developers.appstle.com/bundles/headless-overview.md): Run Appstle's fixed pricing, dynamic pricing, and volume discount bundles with a fully custom storef…
- [Fixed pricing bundle with a custom storefront](https://developers.appstle.com/bundles/fixed-pricing-bundle.md): Sell a curated set of products for one fixed total price using your own storefront UI. Read the rule…
- [Dynamic pricing bundle with a custom storefront](https://developers.appstle.com/bundles/dynamic-pricing-bundle.md): Offer a build-your-own bundle that applies a percentage or fixed-amount discount to the running tota…
- [Volume discount bundle with a custom storefront](https://developers.appstle.com/bundles/volume-discount-bundle.md): Run tiered 'buy more, save more' discounts based on quantity or spend, using your own storefront UI…
- [Partner Integration Framework overview](https://developers.appstle.com/bundles/partner-framework-overview.md): Merchant-friendly overview of the Partner Integration Framework — what it is, how it works, and how…
- [Partner Integration Framework](https://developers.appstle.com/bundles/partner-integration.md): Build a zero-configuration integration between your app and Appstle Bundles, with scoped API tokens…
- [Get all bundle rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-all-bundle-rules.md)
- [Get build-a-box bundle rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-build-a-box-bundle-rules.md)
- [Get discount rules](https://developers.appstle.com/bundles-admin-api/bundle-rules/get-discount-rules.md)
- [Get build-a-box configuration by token](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-build-a-box-configuration-by-token.md)
- [Generate a build-a-box bundle discount](https://developers.appstle.com/bundles-storefront-api/build-a-box/generate-a-build-a-box-bundle-discount.md)
- [Get build-a-box configuration by handle](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-build-a-box-configuration-by-handle.md)
- [Generate a build-a-box shipping discount](https://developers.appstle.com/bundles-storefront-api/build-a-box/generate-a-build-a-box-shipping-discount.md)
- [Get single-product build-a-box configuration](https://developers.appstle.com/bundles-storefront-api/build-a-box/get-single-product-build-a-box-configuration.md)
- [Proxy a Shopify Storefront GraphQL request for build-a-box](https://developers.appstle.com/bundles-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-for-build-a-box.md)
- [Proxy a Shopify Storefront GraphQL request from the customer portal](https://developers.appstle.com/bundles-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal.md)
- [Render the build-a-box storefront page](https://developers.appstle.com/bundles-storefront-api/storefront/render-the-build-a-box-storefront-page.md)
- [Record a storefront visitor ping](https://developers.appstle.com/bundles-storefront-api/storefront/record-a-storefront-visitor-ping.md)

## OpenAPI Specs

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