# Appstle: Memberships

## Memberships

### Get Started

- [Appstle Memberships: Tiered Plans & Access Control](https://developers.appstle.com/memberships/introduction.md): Appstle Memberships lets you build recurring membership programs on Shopify with tiered plans and gated content — via Admin and Customer Portal APIs.
- [Authenticate with the Appstle Memberships API](https://developers.appstle.com/memberships/authentication.md): Create API keys in your Appstle dashboard and pass them via the X-API-Key header. Manage up to 10 keys per store, each independently revocable.
- [Get started with Appstle Memberships API](https://developers.appstle.com/memberships/quickstart.md): Go from zero to your first Memberships API response in minutes: create an API key, retrieve a customer's membership contracts, and check active status.

### Guides

- [Appstle Memberships third-party integration guide](https://developers.appstle.com/memberships/integration-guide.md): Integrate with Appstle Memberships: authentication, base URL, membership management, member data, access control, billing, and common integration patterns.
- [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 update CRMs on lifecycle and billing events.
- [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 how to use them for storefront gating and integrations.

### Partner Integration

- [Partner Integration Framework overview](https://developers.appstle.com/memberships/partner-framework-overview.md): How the Appstle Memberships Partner Integration Framework works — one handshake per merchant, a scoped API token, no API plan required, automatic revocation.
- [Partner Integration Framework](https://developers.appstle.com/memberships/partner-integration.md): Build a seamless, zero-configuration integration between your app and Appstle Memberships using scoped API tokens and a nonce handshake.

### Webhooks

- [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 signature verification, automatic retries, and idempotency.

### Admin API

#### Cancellation Flow Configuration

- [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 memberships. These settings define the cancellation experience including retention offers, surveys, and confirmation flows.

#### Customer Discount History

- [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 membership contract. Returns discount details including code, value, usage limits, and expiration dates from Shopify.

#### Customer Payment Methods

- [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 customer's stored payment tokens used for recurring membership billing.

#### Customer Portal Configuration

- [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 the appearance, behavior, and text labels displayed in the customer self-service portal.

#### Membership Contracts

- [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 address. This token can be used to create magic links or authenticate API requests on behalf of a customer.
- [Generate customer portal magic link](https://developers.appstle.com/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 memberships. This passwordless authentication link directs customers to the membership management portal.
- [Add product line item to membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-line-item-to-membership-contract.md): Adds a new product (line item) to an existing membership contract. This allows customers or merchants to add products to their recurring membership orders.
- [Get membership contract list](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-membership-contract-list.md): Retrieves a paginated list of membership contracts with advanced filtering capabilities. This endpoint provides comprehensive access to all membership contracts in your store with flexible query options.
- [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 (membership plans). This endpoint returns all configured billing frequencies that customers can choose from for their memberships.
- [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 membership order fulfillment details](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-membership-order-fulfillment-details.md): Retrieves fulfillment information for the most recent order generated by a membership contract. Shows shipping status, tracking numbers, and delivery progress.
- [Get pending downgrade for a membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-pending-downgrade-for-a-membership-contract.md): Retrieves the pending/scheduled downgrade details for a specific membership contract. This endpoint returns information about a downgrade that has been scheduled but not yet executed.
- [Cancel pending downgrade for a membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/cancel-pending-downgrade-for-a-membership-contract.md): Cancels a scheduled/pending downgrade for a specific membership contract. This endpoint removes the pending downgrade so that the membership will continue with its current plan.
- [Update product variant in membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-product-variant-in-membership-contract.md): Replaces an existing product variant with a new variant in a membership contract. This allows customers to swap products in their membership while maintaining their membership.
- [Create and add custom discount to membership](https://developers.appstle.com/memberships-admin-api/membership-contracts/create-and-add-custom-discount-to-membership.md): Creates a custom discount and applies it to a membership contract. This endpoint allows you to create on-the-fly discounts without requiring pre-existing discount codes in Shopify.
- [Add product to membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/add-product-to-membership-contract.md): Adds a new product variant to a membership contract's recurring line items. The product will be included in all future recurring orders.
- [Apply discount code to membership](https://developers.appstle.com/memberships-admin-api/membership-contracts/apply-discount-code-to-membership.md): Applies an existing Shopify discount code to a membership contract. The discount code must already exist in Shopify and be valid for membership usage.
- [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 membership management portal. This is a convenience endpoint that combines token generation and email delivery in a single API call.
- [Remove discount from membership](https://developers.appstle.com/memberships-admin-api/membership-contracts/remove-discount-from-membership.md): Removes a discount from a membership contract. This endpoint allows you to remove previously applied discounts, restoring the membership to full price.
- [Remove product from membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/remove-product-from-membership-contract.md): Removes a line item (product) from a membership contract. The product will no longer be included in future recurring orders.
- [Update membership contract billing date](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-membership-contract-billing-date.md): Updates the next billing date for a membership contract. This reschedules when the next payment will be charged for the membership.
- [Update billing interval for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-billing-interval-for-membership-contract.md): Changes the billing frequency of a membership contract. This allows customers to modify how often they are charged for their membership.
- [Update custom note attributes on membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-custom-note-attributes-on-membership-contract.md): Updates custom note attributes (key-value pairs) on a membership contract. These attributes are stored on the Shopify membership contract and propagated to recurring orders.
- [Update delivery interval for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-delivery-interval-for-membership-contract.md): Changes the delivery/shipping frequency of a membership contract. This allows customers to modify how often they receive their membership orders.
- [Update membership line item quantity and pricing](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-membership-line-item-quantity-and-pricing.md): Updates an existing line item in a membership contract, modifying quantity, variant, or price. This endpoint allows comprehensive updates to membership products.
- [Update custom attributes on membership line item](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-custom-attributes-on-membership-line-item.md): Updates custom attributes (metadata) on a specific membership line item. Attributes allow storing custom key-value data on individual products in a membership.
- [Update maximum billing cycles for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-maximum-billing-cycles-for-membership-contract.md): Sets the maximum number of billing cycles (payments) after which the membership will automatically expire and cancel. This is useful for creating fixed-term memberships or limited-duration memberships.
- [Update minimum billing cycles for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-minimum-billing-cycles-for-membership-contract.md): Sets the minimum number of billing cycles (payments) required before a customer can cancel their membership. This is commonly used to enforce commitment periods or prevent early cancellations.
- [Update order note/instructions for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-order-noteinstructions-for-membership-contract.md): Updates the persistent order note attached to a membership contract. This note is automatically included with **EVERY future recurring order** generated from this membership, appearing in Shopify admin order details and printable packing slips.
- [Update membership payment method](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-membership-payment-method.md): Updates the payment method for a membership contract by refreshing payment instrument from Shopify customer. This endpoint syncs the membership's payment method with the customer's default payment method in Shopify.
- [Update shipping address for membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-shipping-address-for-membership-contract.md): Changes the delivery shipping address for a membership contract. This allows customers to update where their membership orders are delivered.
- [Update membership contract status (pause/resume/activate)](https://developers.appstle.com/memberships-admin-api/membership-contracts/update-membership-contract-status-pauseresumeactivate.md): Changes the status of a membership contract. This allows pausing, resuming, or activating memberships to control billing and delivery.
- [Get raw membership contract details from Shopify](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-raw-membership-contract-details-from-shopify.md): Retrieves the complete membership contract data directly from Shopify's GraphQL API. This returns the full, unmodified Shopify contract object with all nested data.
- [Cancel membership contract](https://developers.appstle.com/memberships-admin-api/membership-contracts/cancel-membership-contract.md): Cancels a membership contract and sends cancellation confirmation emails. This endpoint terminates the recurring membership and processes all cancellation workflows.
- [Get detailed customer membership information](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-detailed-customer-membership-information.md): Retrieves comprehensive details for all membership contracts associated with a specific customer. This endpoint returns complete membership contract data including products, pricing, billing schedule, and status.
- [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 membership contract IDs for customer](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-valid-membership-contract-ids-for-customer.md): Retrieves a list of all valid (active, paused, or pending) membership contract IDs associated with a specific customer. This endpoint is useful for quickly checking which memberships a customer has without retrieving full contract details.
- [Get membership customer details](https://developers.appstle.com/memberships-admin-api/membership-contracts/get-membership-customer-details.md): Retrieves comprehensive customer information from Shopify for a specific customer ID. This endpoint fetches the customer record directly from Shopify's API, returning all personal details, addresses, payment methods, and metadata associated with the customer account.

#### Shipping & Delivery Profiles

- [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 new integrations, prefer the V2 endpoint which supports more advanced configuration.
- [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 profiles control which shipping options are available to customers at checkout for membership orders.

#### Product Swap Rules

- [Get product swap options for membership items](https://developers.appstle.com/memberships-admin-api/product-swap-rules/get-product-swap-options-for-membership-items.md): Retrieves available product swap/substitution options for specified variants based on configured swap rules. Returns multiple levels of swap suggestions allowing members to exchange products in their memberships.

#### Billing & Orders

- [Update membership billing attempt](https://developers.appstle.com/memberships-admin-api/billing-&-orders/update-membership-billing-attempt.md): Updates billing attempt details for a membership contract. Billing attempts represent individual charge attempts for recurring membership orders.
- [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 with the billing attempt and will appear on the Shopify order when it's created. Order notes are visible to merchants in Shopify admin and can be printed on packing slips.
- [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 membership contract, bypassing the normal scheduled billing time. This endpoint processes the billing asynchronously via Shopify's Subscription Billing API, creating an order and charging the customer's payment method.
- [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 completed billing attempts for reporting and history display.
- [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 membership billing attempts filtered by status (SUCCESS, FAILURE, QUEUED, SKIPPED) with optional contract filtering.
- [Skip upcoming membership order](https://developers.appstle.com/memberships-admin-api/billing-&-orders/skip-upcoming-membership-order.md): Skips a scheduled billing attempt, preventing the order from being processed. The next billing date is automatically recalculated based on the membership frequency.
- [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 that haven't been processed yet.

#### One-Time Add-Ons

- [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 contract. One-offs are products added to a single billing cycle without affecting the recurring membership items.
- [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. The product will be included only in the specified order and will not become part of the recurring membership.
- [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 allows customers or merchants to cancel add-on items before the order is processed.

#### Custom CSS Styling

- [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 membership widgets and customer portal. These styles allow merchants to customize the visual appearance of membership elements to match their brand.

#### Membership Plans

- [List all membership plan groups](https://developers.appstle.com/memberships-admin-api/membership-plans/list-all-membership-plan-groups.md): Retrieves all membership plan groups for the authenticated shop, including plan details, discount configurations, and product assignments.
- [Get a membership plan group](https://developers.appstle.com/memberships-admin-api/membership-plans/get-a-membership-plan-group.md): Retrieves a specific membership plan group by its Shopify selling plan group ID, including all plan configurations and assigned products.

### Customer Portal API

#### Cancellation Flow Configuration

- [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, and survey settings.

#### Customer Discount History

- [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 membership contracts.

#### Customer Portal Configuration

- [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, and branding options.
- [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)

#### Customer Retention

- [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 other retention-related actions.

#### Product & Inventory Data

- [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 membership-enabled products with pagination](https://developers.appstle.com/memberships-customer-portal-api/product-&-inventory-data/search-membership-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)

#### Shipping & Delivery Profiles

- [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 membership delivery.

#### Loyalty Integration

- [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 membership contract, including points balance.
- [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 membership contract using the specified redemption option.
- [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.

#### Product Swap Rules

- [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 to exchange membership items.

#### Shop Settings

- [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.

#### Billing & Orders

- [Update billing attempt](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/update-billing-attempt.md): Updates a membership 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 membership billing record from the customer portal.
- [Get past orders](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/get-past-orders.md): Retrieves past order history for a membership 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 the next billing date is moved to the following cycle.
- [Get upcoming orders](https://developers.appstle.com/memberships-customer-portal-api/billing-&-orders/get-upcoming-orders.md): Retrieves upcoming/scheduled orders for a membership contract from the customer portal.

#### Membership Contracts

- [Update membership contract details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/update-membership-contract-details.md): Updates an existing membership 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 membership contract.
- [Get customer membership details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-customer-membership-details.md): Retrieves membership 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 membership contract](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/list-shopify-fulfillments-for-a-membership-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 membership 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 membership 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 membership contract, allowing customers to swap to a different variant.
- [Apply discount code](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/apply-discount-code.md): Applies a discount code to a membership 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 membership contract as part of the cancellation flow to retain the customer.
- [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 membership.
- [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 membership 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 membership 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 membership 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 membership 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 membership 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 membership 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 membership 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 membership 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 membership 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 is one of the most critical operations for managing membership lifecycles.
- [Get raw Shopify membership contract data](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-raw-shopify-membership-contract-data.md)
- [Get membership contract details](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-membership-contract-details.md): Retrieves the raw membership 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 billing and marks the membership as CANCELLED.
- [Get current customer's membership profile](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-current-customers-membership-profile.md)
- [Get valid membership contracts for a customer](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/get-valid-membership-contracts-for-a-customer.md)
- [List current customer's valid membership contract IDs](https://developers.appstle.com/memberships-customer-portal-api/membership-contracts/list-current-customers-valid-membership-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 membership contract from the customer portal.

#### One-Time Add-Ons

- [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 membership contract and billing attempt.
- [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 membership contract's upcoming billing attempt.

#### Custom CSS Styling

- [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 membership customer portal and widgets.

#### Membership Plans

- [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 customers.

## OpenAPI Specs

- [admin-api-swagger](/memberships/admin-api-swagger.json)
- [storefront-api-swagger](/memberships/storefront-api-swagger.json)
