# Supercycle - [Supercycle docs](https://docs.supercycle.com/documentation/index.md): Learn how to run rental, subscription, membership, and resale on your Shopify store with Supercycle - [Platform overview](https://docs.supercycle.com/documentation/overview/platform.md): How Supercycle builds on Shopify's products, orders, checkout, and customer accounts to run circular models - [Methods](https://docs.supercycle.com/documentation/overview/methods.md): The ways Supercycle lets you charge for the same item more than once - [Setup guide](https://docs.supercycle.com/documentation/setup/setup-guide.md): Install Supercycle, import products, add items and a method, and add the app embed to your theme - [Import products](https://docs.supercycle.com/documentation/setup/importing-products.md): Include Shopify products in Supercycle so it can manage their items, availability, and pricing - [Methods setup](https://docs.supercycle.com/documentation/setup/methods-setup.md): Turn on a method for each product and set its pricing before customers can rent or buy it - [Theme setup](https://docs.supercycle.com/documentation/setup/theme-setup.md): Turn on the Supercycle Engine app embed, add the Methods app block, and style them to match your theme - [Admin setup](https://docs.supercycle.com/documentation/setup/admin-setup.md): Show Supercycle cycles and inventory on Shopify's customer, order, and product pages with admin blocks - [Calendar overview](https://docs.supercycle.com/documentation/methods/calendar/overview.md): Rent items between two dates, at a price you set for each rental period - [Product setup](https://docs.supercycle.com/documentation/methods/calendar/product-setup.md): Turn on calendar rental for a product and add the rental periods customers can pick - [Fixed fees](https://docs.supercycle.com/documentation/methods/calendar/fixed-fees.md): Add set fees such as cleaning, insurance, or return shipping on top of the rental period price - [Membership overview](https://docs.supercycle.com/documentation/methods/membership/overview.md): Give customers access to your catalog for one recurring price, with credits they swap between items - [Credit systems](https://docs.supercycle.com/documentation/methods/membership/credit-systems.md): Choose whether every item costs one credit or each product carries its own credit cost - [Product setup](https://docs.supercycle.com/documentation/methods/membership/product-setup.md): Turn on membership for a product, set its credit cost, and validate membership items in the cart - [Plans setup](https://docs.supercycle.com/documentation/methods/membership/plans-setup.md): Create the membership plans customers subscribe to and the page they join from - [Subscription overview](https://docs.supercycle.com/documentation/methods/subscription/overview.md): Rent one product for a recurring price until the customer sends it back - [Subscription settings](https://docs.supercycle.com/documentation/methods/subscription/subscription-settings.md): Control when subscription billing starts and stops, the default interval, and the start date picker - [Product setup](https://docs.supercycle.com/documentation/methods/subscription/product-setup.md): Turn on subscription rental for a product and create the pricing groups customers pick from - [Add a disclaimer](https://docs.supercycle.com/documentation/methods/subscription/add-a-disclaimer.md): Show a note under the start date field in the Subscribe card to set delivery expectations - [Resale overview](https://docs.supercycle.com/documentation/methods/resale/overview.md): Sell serialized secondhand items at prices set per condition, alongside your rental methods - [Product setup](https://docs.supercycle.com/documentation/methods/resale/product-setup.md): Turn on resale for a product and create pricing options per item condition or variant - [Products overview](https://docs.supercycle.com/documentation/manage/products/products.md): Import Shopify products into Supercycle and run circular methods on them - [Method options](https://docs.supercycle.com/documentation/manage/products/managing-method-options.md): Edit the prices, periods, and targeting of many method options at once - [Multi-market pricing](https://docs.supercycle.com/documentation/manage/products/multi-market-pricing.md): Show different method options and prices to customers in each Shopify market - [Bundles](https://docs.supercycle.com/documentation/manage/products/bundles.md): Group several products into one rentable set, such as a suit made of a jacket and trousers - [Add-ons](https://docs.supercycle.com/documentation/manage/products/add-ons.md): Offer optional or required extras alongside a rental, such as damage protection or cleaning - [Product actions](https://docs.supercycle.com/documentation/manage/products/product-actions.md): Import products into Supercycle and update their method pricing options - [Items overview](https://docs.supercycle.com/documentation/manage/inventory/items.md): The individual physical units behind each variant, and everything the item page tracks - [Item conditions](https://docs.supercycle.com/documentation/manage/inventory/item-conditions.md): Grade the state of each item, and let customers pick the grade they want to rent or buy - [Serializing items](https://docs.supercycle.com/documentation/manage/inventory/serializing-items.md): Give every item a scannable unique identifier, and pick the tag type that fits your operation - [Overselling items](https://docs.supercycle.com/documentation/manage/inventory/overselling.md): Allow orders beyond the items available in Supercycle, so cycles can exist without an allocated item - [Schedule](https://docs.supercycle.com/documentation/manage/inventory/schedule.md): See how each variant is booked day by day, including buffers and blocked dates - [Blocked dates](https://docs.supercycle.com/documentation/manage/inventory/blocked-dates.md): Stop the whole store, a product, a variant, or one item being booked for a set period - [Waitlist](https://docs.supercycle.com/documentation/manage/inventory/waitlist.md): Let customers sign up to be notified when an item is back in stock - [Item actions](https://docs.supercycle.com/documentation/manage/inventory/item-actions.md): Create, update, restrict, retire, and delete the individual items in your inventory - [Inventory troubleshooting](https://docs.supercycle.com/documentation/manage/inventory/inventory-troubleshooting.md): Problems you might hit with items and inventory, and how to fix them - [Cycles overview](https://docs.supercycle.com/documentation/manage/cycles/cycles.md): The record that tracks one item going out to a customer and coming back again - [Create cycle order](https://docs.supercycle.com/documentation/manage/cycles/create-cycles-order.md): Create a cycle order for a customer from the admin and take payment on a Shopify draft order - [Cycle fulfillment](https://docs.supercycle.com/documentation/manage/cycles/fulfil-a-rental.md): Find the cycles due out today, print their labels, and fulfill them in Shopify - [Allocation](https://docs.supercycle.com/documentation/manage/cycles/allocation.md): How Supercycle picks the item for each cycle so future customers see the widest dates - [Edit cycles on order](https://docs.supercycle.com/documentation/manage/cycles/edit-an-order.md): Add or remove cycles on an existing Shopify order and settle the difference either way - [Convert to purchase](https://docs.supercycle.com/documentation/manage/cycles/convert-to-purchase.md): Turn an active cycle into a sale so the customer keeps the item, and set how the charge is priced - [Cycle extensions](https://docs.supercycle.com/documentation/manage/cycles/extensions.md): Let customers keep a calendar rental for longer and pay the difference from their account - [Cycle statuses](https://docs.supercycle.com/documentation/manage/cycles/cycle-statuses.md): Every status a cycle can carry, when Supercycle sets it, and what it tells you - [Cycle actions](https://docs.supercycle.com/documentation/manage/cycles/cycle-actions.md): Step-by-step guides for creating, fulfilling, updating, and canceling cycles - [Cycle troubleshooting](https://docs.supercycle.com/documentation/manage/cycles/cycle-troubleshooting.md): Problems you might hit with cycles, what causes them, and how to fix each one - [Returns overview](https://docs.supercycle.com/documentation/manage/returns/returns.md): Track items coming back from customers, from the return request to receival - [Return actions](https://docs.supercycle.com/documentation/manage/returns/return-actions.md): Step-by-step guides for creating returns and receiving items back from customers - [Charges overview](https://docs.supercycle.com/documentation/manage/charges/charges.md): Track what each customer owes for a rental or membership and how each charge was paid - [Payment attempts](https://docs.supercycle.com/documentation/manage/charges/payments.md): How Supercycle tries to collect a charge and what happens when an attempt succeeds - [Charge types and tax](https://docs.supercycle.com/documentation/manage/charges/charge-types.md): Set the tax on a manual charge, and create reusable charge types that carry their own tax rate - [Charge actions](https://docs.supercycle.com/documentation/manage/charges/charge-actions.md): Step-by-step guides for creating charges, collecting payment, and changing a customer's card - [Subscription contracts](https://docs.supercycle.com/documentation/manage/subscriptions/subscription-contracts.md): The record behind every recurring charge, and how to find the ones that need you - [Managing subscriptions](https://docs.supercycle.com/documentation/manage/subscriptions/managing-subscriptions.md): Start a subscription for a customer, and run it from the cycle once it's billing - [Managing memberships](https://docs.supercycle.com/documentation/manage/subscriptions/managing-memberships.md): Start a membership, run it from the customer page, and change its allowances, nickname, and billing - [Dunning](https://docs.supercycle.com/documentation/manage/subscriptions/dunning.md): Retry failed subscription and membership payments on a schedule you set - [Billing statuses](https://docs.supercycle.com/documentation/manage/subscriptions/billing-statuses.md): What each billing status badge means, and the failure code behind every declined payment - [Shopify tags](https://docs.supercycle.com/documentation/manage/subscriptions/shopify-tags.md): The Shopify tags Supercycle adds to membership customers and their orders, for segments and automation - [Subscription actions](https://docs.supercycle.com/documentation/manage/subscriptions/subscription-actions.md): Step-by-step guides for changing what a contract bills, when it bills, and which card it charges - [Subscription troubleshooting](https://docs.supercycle.com/documentation/manage/subscriptions/subscription-troubleshooting.md): Contracts that have stopped collecting, why they stopped, and how to get them billing again - [Automation overview](https://docs.supercycle.com/documentation/manage/automation/automation.md): Automate with triggers and actions using Shopify Flow - [Create a workflow](https://docs.supercycle.com/documentation/manage/automation/create-workflow.md): Build an automation from a Supercycle trigger and action in Shopify Flow - [Consignment overview](https://docs.supercycle.com/documentation/manage/consignment/overview.md): Sell stock owned by brand partners and track the revenue share you owe them - [Consignors](https://docs.supercycle.com/documentation/manage/consignment/consignors.md): Add the brand partners whose stock you sell, and set what each one earns - [Revenue share formulas](https://docs.supercycle.com/documentation/manage/consignment/revenue-share-formulas.md): Write consignor revenue shares as Liquid formulas, including tiered rates and per-item deductions - [Assigning items](https://docs.supercycle.com/documentation/manage/consignment/assigning-items.md): Link items to a consignor so they earn a revenue share when the item is paid for - [Payouts](https://docs.supercycle.com/documentation/manage/consignment/payouts.md): Track what you owe consignors and record the payments you make to settle it - [Consignor customer accounts](https://docs.supercycle.com/documentation/manage/consignment/consignor-portal.md): What a consignor sees about their balance, earnings, and payouts in their account - [Consignment actions](https://docs.supercycle.com/documentation/manage/consignment/consignment-actions.md): Step-by-step guides for setting up consignment, adding consignors, and paying them - [Analytics overview](https://docs.supercycle.com/documentation/manage/analytics/overview.md): Where to get the numbers for your circular commerce business, and which source to use - [Analytics dashboards](https://docs.supercycle.com/documentation/manage/analytics/dashboards.md): Supercycle's built-in reporting on utilization, yield, lifecycle ROI, revenue, and billing - [Shopify Analytics](https://docs.supercycle.com/documentation/manage/analytics/shopify-analytics.md): Track circular commerce performance alongside retail in Shopify's own reports - [Customer segments](https://docs.supercycle.com/documentation/manage/analytics/segments.md): Group customers with the tags Supercycle applies, for marketing, discounts, and reports - [Scanner overview](https://docs.supercycle.com/documentation/manage/scanner/scanner.md): Scan items to take them in, receive returns, and update locations from your phone or a Zebra device - [Scanner actions](https://docs.supercycle.com/documentation/manage/scanner/scanner-actions.md): Step-by-step guides for creating items, receiving returns, and updating items from the Supercycle Scanner - [Customer accounts](https://docs.supercycle.com/documentation/online-store/portal.md): Let customers manage rentals, returns, memberships, and subscriptions from their Shopify account - [Availability search](https://docs.supercycle.com/documentation/online-store/search.md): Let customers filter a collection to the products available for the dates they want to rent - [Cart timer](https://docs.supercycle.com/documentation/online-store/cart-timer.md): Remove Supercycle items from a cart after a set time so abandoned carts don't block bookings - [Date picker blocked dates](https://docs.supercycle.com/documentation/online-store/date-picker-blocks.md): Stop customers picking certain start or end dates on the storefront calendar without touching inventory - [Languages](https://docs.supercycle.com/documentation/online-store/languages.md): Publish the languages Supercycle shows to customers and edit the wording of its blocks, pages, and emails - [POS overview](https://docs.supercycle.com/documentation/point-of-sale/pos-overview.md): Create and manage cycles from Shopify POS with the calendar, subscription, membership, and resale methods - [Supercycle notifications](https://docs.supercycle.com/supercycle-notifications.md): The emails Supercycle sends your customers, and how to edit, brand, and deliver them - [Shopify notifications](https://docs.supercycle.com/shopify-notifications.md): Customize Shopify's order and customer emails for rentals, subscriptions, and charges with Liquid snippets - [Locations](https://docs.supercycle.com/documentation/configuration/logistics/locations.md): Track which warehouse or store each item is stored at, and let customers choose a location before they book - [Logistics buffers](https://docs.supercycle.com/documentation/configuration/logistics/buffers.md): Add preparation, delivery, and restock time around rentals so items are ready before they can be booked again - [Order cutoff time](https://docs.supercycle.com/documentation/configuration/logistics/order-cutoff-time.md): Set the latest time a customer can order for a given dispatch day, including time zones and no-dispatch days - [Pickup in store](https://docs.supercycle.com/documentation/configuration/logistics/pickup-in-store.md): Let customers collect rentals from one of your store locations instead of having them shipped - [Drop-off returns](https://docs.supercycle.com/documentation/configuration/logistics/drop-off-returns.md): Let customers return rentals in person at one of your store locations instead of shipping them back - [Opening hours](https://docs.supercycle.com/documentation/configuration/logistics/opening-hours.md): Set per-location opening hours so customers pick a pickup or drop-off time that works for each store - [Logistics troubleshooting](https://docs.supercycle.com/documentation/configuration/logistics/logistics-troubleshooting.md): Fix shipping fees charged twice and misleading shipping dates at checkout - [Identity verification](https://docs.supercycle.com/documentation/configuration/risk/identity-verification.md): Verify customers' identities with face-matching liveness checks against government-issued IDs before they rent - [Card vaulting](https://docs.supercycle.com/documentation/configuration/risk/card-vaulting.md): Save a customer's payment method at checkout so you can charge it later for damage, late returns, or extensions - [Deposits](https://docs.supercycle.com/documentation/configuration/risk/deposits.md): Hold a refundable deposit against a rental to cover damage or loss, and refund it when the item comes back - [E-signatures](https://docs.supercycle.com/documentation/configuration/risk/e-signatures.md): Require customers to sign rental contracts online or in store before you fulfill a rental - [Terms and conditions](https://docs.supercycle.com/documentation/configuration/risk/terms-and-conditions.md): Create terms records, attach them to method options, and require customers to accept them before renting - [Payment gateways](https://docs.supercycle.com/documentation/configuration/checkout/payments.md): Use a supported payment gateway, and test checkout with Shopify Payments in test mode while you build - [Checkout rules](https://docs.supercycle.com/documentation/configuration/checkout/checkout-rules.md): Turn on Supercycle's checkout validation to prevent overbooking and other rental checkout errors - [Checkout language](https://docs.supercycle.com/documentation/configuration/checkout/checkout-language.md): Edit or remove the default Shopify checkout messages that confuse rental customers - [Override dates](https://docs.supercycle.com/documentation/configuration/overrides/override-dates.md): Charge a different calendar price during a season, on certain days of the week, or for a one-off event - [Custom fields](https://docs.supercycle.com/documentation/configuration/custom-data/custom-fields.md): Add your own fields to items, cycles, and consignors to capture the data your business runs on - [Calculated fields](https://docs.supercycle.com/documentation/configuration/custom-data/calculated-fields.md): Derive read-only custom field values from a Liquid formula over custom fields, system fields, and metafields - [Migrations overview](https://docs.supercycle.com/documentation/configuration/migrations/overview.md): Requirements and migration paths for moving an existing rental or subscription business to Supercycle - [Migrate subscriptions](https://docs.supercycle.com/documentation/configuration/migrations/subscriptions.md): Move subscriptions from another app or system into Supercycle without interrupting billing - [Migrate from Stripe](https://docs.supercycle.com/documentation/configuration/migrations/stripe.md): Import your Stripe customers and their vaulted payment methods into Shopify and Supercycle - [Patchworks integration](https://docs.supercycle.com/documentation/configuration/integrations/patchworks.md): Connect Supercycle to your warehouse, 3PL, and finance systems with pre-built Patchworks connectors - [Developers](https://docs.supercycle.com/developers/index.md): Learn about customization, read metafields, and extend the storefront with code - [Metafields](https://docs.supercycle.com/developers/metafields.md): The Shopify metafields Supercycle writes on products, variants, and customers, and how to read them in Liquid - [Cycle line item property](https://docs.supercycle.com/developers/line-items/cycle-line-item-properties.md): Schema for the _cycle line item property that tells Supercycle how to create a cycle from a cart line - [Validations line item property](https://docs.supercycle.com/developers/line-items/validations-line-item-property.md): Schema for the _validations line item property that Supercycle enforces in the cart and at checkout - [Methods](https://docs.supercycle.com/developers/app-blocks/methods.md): Add every method a product offers to the product page and let Supercycle control the add to cart button - [Availability search](https://docs.supercycle.com/developers/app-blocks/availability-search.md): Let customers filter a collection by rental dates or method, and drive the filter from your own code - [Membership plans](https://docs.supercycle.com/developers/app-blocks/membership-plans.md): Show your membership plans as cards on any page so customers can join - [Display method prices](https://docs.supercycle.com/developers/code-snippets/display-prices.md): Show each method's price on product cards and product pages with a Liquid snippet - [Show recurring payments in the cart](https://docs.supercycle.com/developers/code-snippets/show-recurring-payments.md): Show plan names, first payments, and the recurring total on cart lines for selling plan products - [Link new and circular products](https://docs.supercycle.com/developers/code-snippets/link-new-and-circular.md): Add a switcher between a product sold new and its circular twin on the same product page - [Target method options by name](https://docs.supercycle.com/developers/code-snippets/target-method-options.md): Use the data-supercycle-option-name attribute to style or hide specific method options from your theme - [Build an hourly booking widget](https://docs.supercycle.com/developers/guides/build-an-hourly-booking-widget.md): Build a custom storefront widget that books rentals by date and time of day on the Storefront API - [Rental bundles](https://docs.supercycle.com/developers/bundles.md): Group component products into one rentable bundle and build the storefront flow on the Storefront API - [Methods app block troubleshooting](https://docs.supercycle.com/developers/troubleshooting/method-app-block.md): Fix the Methods app block when it doesn't appear, can't find the product form, or leaves the button stuck - [Supercycle Admin API](https://docs.supercycle.com/api-reference/admin/index.md): Read and update your Supercycle cycles, items, charges, products, and customers over REST - [Authentication](https://docs.supercycle.com/api-reference/admin/authentication.md): Create an API key in the Supercycle admin and send it as a bearer token on every request - [Pagination](https://docs.supercycle.com/api-reference/admin/pagination.md): List endpoints use keyset pagination, with a limit per request and a cursor for the next page - [List all conditions](https://docs.supercycle.com/api-reference/admin/conditions/list-all-conditions.md): Returns a list of conditions. - [List all locations](https://docs.supercycle.com/api-reference/admin/locations/list-all-locations.md): Returns a list of locations. - [Variant availability timeline](https://docs.supercycle.com/api-reference/admin/availabilitytimelines/variant-availability-timeline.md): Returns per-day available inventory counts for a variant over a forward window. - [List blocked dates](https://docs.supercycle.com/api-reference/admin/blockeddates/list-blocked-dates.md): Returns manually blocked date ranges for items, variants, products, and the entire store. Rental scheduling blocks are excluded; only merchant-created blocked dates are returned. - [Create a blocked date](https://docs.supercycle.com/api-reference/admin/blockeddates/create-a-blocked-date.md): Creates a manually blocked date range for an item, variant, product, or the entire store. Rental scheduling blocks cannot be created through this endpoint. - [Get a blocked date](https://docs.supercycle.com/api-reference/admin/blockeddates/get-a-blocked-date.md): Returns a single manually blocked date range by ID. - [Delete a blocked date](https://docs.supercycle.com/api-reference/admin/blockeddates/delete-a-blocked-date.md): Permanently removes a manually blocked date range, restoring availability for the affected item, variant, product, or store. - [List custom field definitions](https://docs.supercycle.com/api-reference/admin/customfielddefinitions/list-custom-field-definitions.md): Returns a list of custom field definitions filtered by owner type. - [Retrieve a custom field definition](https://docs.supercycle.com/api-reference/admin/customfielddefinitions/retrieve-a-custom-field-definition.md): Returns details of a specific custom field definition. - [Create a custom field](https://docs.supercycle.com/api-reference/admin/customfields/create-a-custom-field.md): Create a custom field on an item or rental. Specify the definition either by definitionId, or by key and ownerType. - [Update a custom field](https://docs.supercycle.com/api-reference/admin/customfields/update-a-custom-field.md): Update the value of an existing custom field. - [Delete a custom field](https://docs.supercycle.com/api-reference/admin/customfields/delete-a-custom-field.md): Delete an existing custom field. - [Start a file upload for a custom field](https://docs.supercycle.com/api-reference/admin/customfields/start-a-file-upload-for-a-custom-field.md): Reserve a direct upload for one file on a file-type custom field (such as an image). PUT the file's bytes to `directUpload.url` with `directUpload.headers`, then create or update the custom field with the returned `signedId` as its value. The file is checked against the definition's allowed types an… - [List all items](https://docs.supercycle.com/api-reference/admin/items/list-all-items.md): Returns a list of items and their details given parameters. Used by merchants to view their inventory. - [Create an item](https://docs.supercycle.com/api-reference/admin/items/create-an-item.md): Create a new item against a product that has already been imported into Supercycle. - [Retrieve an item](https://docs.supercycle.com/api-reference/admin/items/retrieve-an-item.md): Returns all fields on an item. Can include timeline events if requested. - [Update an item](https://docs.supercycle.com/api-reference/admin/items/update-an-item.md): Update an item's serial, condition, processing status, or, in future, its metafields. - [List all products](https://docs.supercycle.com/api-reference/admin/products/list-all-products.md): Returns a list of all products in Supercycle. Likely to be used in conjunction with Shopify API to display information about the products. - [Import products](https://docs.supercycle.com/api-reference/admin/products/import-products.md): Import Shopify products into Supercycle by list. - [Create or update subscription method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-subscription-method.md): Creates or updates a subscription method for a product. - [Create subscription method option](https://docs.supercycle.com/api-reference/admin/products/create-subscription-method-option.md): Creates an option for a product's subscription method. If the method does not exist, it is created first. - [Create or update calendar method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-calendar-method.md): Creates or updates a calendar method for a product. - [Create calendar method option](https://docs.supercycle.com/api-reference/admin/products/create-calendar-method-option.md): Creates an option for a product's calendar method. If the method does not exist, it is created first. - [Create or update membership method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-membership-method.md): Creates or updates a membership method for a product. - [Create membership method option](https://docs.supercycle.com/api-reference/admin/products/create-membership-method-option.md): Creates an option for a product's membership method. If the method does not exist, it is created first. - [Create or update resale method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-resale-method.md): Creates or updates a resale method for a product. - [Create resale method option](https://docs.supercycle.com/api-reference/admin/products/create-resale-method-option.md): Creates an option for a product's resale method. If the method does not exist, it is created first. - [List all cycles](https://docs.supercycle.com/api-reference/admin/cycles/list-all-cycles.md): Returns a list of cycles given parameters. Used by merchants to see cycles due for dispatch, return etc. - [Retrieve a cycle](https://docs.supercycle.com/api-reference/admin/cycles/retrieve-a-cycle.md): View information about a single cycle. Can include timeline events if requested. - [Update a cycle](https://docs.supercycle.com/api-reference/admin/cycles/update-a-cycle.md): Update details about a cycle - either edits or despatch/return information. Merchants may also update the Shopify order/fulfillment at the same time via the Shopify API. - [List all rentals (deprecated alias of /cycles)](https://docs.supercycle.com/api-reference/admin/rentals/list-all-rentals-deprecated-alias-of-cycles.md): Returns a list of rentals given parameters. Used by merchants to see rentals due for dispatch, return etc. - [Retrieve a rental (deprecated alias of /cycles/{cycleId})](https://docs.supercycle.com/api-reference/admin/rentals/retrieve-a-rental-deprecated-alias-of-cycles-.md): View information about a single rental. Can include timeline events if requested. - [Update a rental (deprecated alias of /cycles/{cycleId})](https://docs.supercycle.com/api-reference/admin/rentals/update-a-rental-deprecated-alias-of-cycles-.md): Update details about a rental - either edits or despatch/return information. Merchants may also update the Shopify order/fulfillment at the same time via the Shopify API. - [Update a membership credit](https://docs.supercycle.com/api-reference/admin/rentals/update-a-membership-credit.md): Return (recredit) or reclaim a membership credit on a rental. Set status to `returned` to credit the customer back, or `unreturned` to reclaim a previously returned credit. - [List all returns](https://docs.supercycle.com/api-reference/admin/returnorders/list-all-returns.md): Get a list of returns, their details and items, given parameters. Used by merchants to list registered returns to start, or check if an item already exists in a return. - [Create a return](https://docs.supercycle.com/api-reference/admin/returnorders/create-a-return.md): Create a return by items. Return line statuses and conditions can be specified. If an item is in an existing return and has not active rentals, the endpoint updates the return line. If the item has multiple active rentals, the rental ID must be specified (return rental IDs with error). - [Retrieve a return](https://docs.supercycle.com/api-reference/admin/returnorders/retrieve-a-return.md): View information about a return. Can include timeline events if requested. - [Update a return](https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return.md): Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses. - [Create a timeline comment](https://docs.supercycle.com/api-reference/admin/timelinecomments/create-a-timeline-comment.md): Creates a new comment associated with a timeline event for a specific resource in a shop. The resource must belong to the authenticated shop. - [Delete a timeline comment](https://docs.supercycle.com/api-reference/admin/timelinecomments/delete-a-timeline-comment.md): Deletes a timeline comment event for a specific shop. Only events with type 'comment' can be deleted. - [Supercycle Storefront API](https://docs.supercycle.com/api-reference/storefront/index.md): Build custom storefront experiences on Supercycle's availability and intent endpoints - [Requests](https://docs.supercycle.com/api-reference/storefront/requests.md): Send Storefront API requests through the Shopify app proxy on your store's own domain - [Intent](https://docs.supercycle.com/api-reference/storefront/intent.md): Create a rental intent for a variant, including any add-ons, through the Storefront API - [Product availability](https://docs.supercycle.com/api-reference/storefront/product-availability.md): Fetch the availability of every variant for a set of products - [Availability timeline](https://docs.supercycle.com/api-reference/storefront/availability-timelines.md): Fetch a day-by-day count of available items for a variant across a 12-month window - [Availability log](https://docs.supercycle.com/api-reference/storefront/availability-log.md): Fetch a variant's availability with time-of-day precision, for hourly and time-slot booking - [AI at Supercycle](https://docs.supercycle.com/ai/index.md): How AI helps you support customers, run operations, and build on Supercycle - [Our approach to AI](https://docs.supercycle.com/ai/approach.md): How Supercycle thinks about AI: open standards, answers at the point of decision, and specialist partners - [Overview](https://docs.supercycle.com/ai/support/overview.md): Get answers about Supercycle setup, features, and troubleshooting from the documentation AI - [Overview](https://docs.supercycle.com/ai/operations/overview.md): Review, audit, and act on your circular operations from your preferred AI chat with the Operators MCP - [Overview](https://docs.supercycle.com/ai/building/overview.md): Build custom tools, integrations, and workflows on the Supercycle API with AI assistance - [Guidance for AI](https://docs.supercycle.com/ai/building/guidance-for-ai.md): Instructions for AI agents building on Supercycle through the Builders MCP and the APIs - [Operators MCP](https://docs.supercycle.com/ai/operators-mcp/overview.md): Manage cycles, inventory, customers, returns, and charges from your preferred AI chat - [Setup](https://docs.supercycle.com/ai/operators-mcp/setup.md): Connect the Operators MCP to ChatGPT, Claude, Claude Code, or any MCP client with your Shopify login - [Tools](https://docs.supercycle.com/ai/operators-mcp/tools.md): Every Operators MCP tool and its parameters, grouped by the resource it works on - [Security](https://docs.supercycle.com/ai/operators-mcp/security.md): How the Operators MCP authenticates, what each OAuth access level allows, and how writes are confirmed - [Builders MCP](https://docs.supercycle.com/ai/builders-mcp/overview.md): Give your AI tools direct access to Supercycle's documentation and API reference - [Setup](https://docs.supercycle.com/ai/builders-mcp/setup.md): Connect the Builders MCP to ChatGPT, Claude, Cursor, VS Code, Retool, Lovable, or any MCP client - [Shopify Sidekick](https://docs.supercycle.com/ai/sidekick/shopify-sidekick.md): Ask Sidekick about your cycles, customers, and returns, and include products in Supercycle from the Shopify admin - [Platform changelog](https://docs.supercycle.com/changelog/platform.md): New features and improvements across the Supercycle platform, newest first - [API changelog](https://docs.supercycle.com/changelog/api.md): Updates to the Supercycle Admin API and Storefront API ## OpenAPI Specs - [openapi](/api-reference/openapi.json) - [openapi](/api-reference/storefront/openapi.yml) - [openapi-v1](https://app.supercycle.com/docs/openapi-v1.yml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.