# Sherpo merchant API ## Pages - [Sherpo merchant API](https://docs.sherpo.io/merchant-api/reference/index.md) — Rich text fields take HTML in a closed format; anything else is refused as invalid, naming the field's path and the reason, so fix it and retry. Allowed: p, h1 (Title), h2 (Heading), h3 (Subheading), br; marks strong, em, u, s, sup, sub, code (b as strong, i as em, del as s, strike as s); a with href (http, https, mailto, tel, ftp, ftps, callto, sms, cid, xmpp, irc, ircs or a relative path), target="_blank"; span with style color or background-color (#rgb or #rrggbb); style text-align (left, center, right, justify) on p and h1 to h3; ul; ol (start); li (data-checked="true" or "false" for a task list); table, thead, tbody, tr, th, td (colspan, rowspan); pre with one code (class="language-", the id one of bash, c, cpp, csharp, css, go, xml, java, javascript, json, kotlin, markdown, php, python, ruby, rust, sql, swift, typescript, yaml); blockquote; hr; details (open) with its summary first; figure with at most one figcaption, first or last; a link's rel (noopener, noreferrer, nofollow) is read and never stored. Images, videos, audio, slideshows, formulas, diagrams, downloads and other blocks are elements (no raw img or video); which types a field takes is in its description. getBodySchema answers each block's props, their values and which are required, for every kind of body; a block with an unknown type, an unknown prop or a value outside its set is refused, naming the block and what the prop takes. Refused: any other tag, attribute or style (div, section, img, iframe, script, comments…), a link or a block inside a link, a figure inside a figure. At most 1 MiB of UTF-8 (and each field's own limit), markup nested at most 32 deep, tables covering at most 10000 cells in all (each its rows times its widest row, spans counted). Reads return the stored canonical form, wrapped in ; send it back as it is to keep a text. To write Markdown instead, set text_format to "markdown": each text, up to 64 KiB, is converted into the format, raw HTML in it kept, a $$ fence or a paragraph that is one $$ … $$ line a formula block (a fence nothing closes stays text), and a mermaid fence a diagram block (one of a type the store's page doesn't draw, or that the diagram rules refuse, stays code; one that still can't be drawn, or past 10 new diagrams in a save, is refused), and validated the same way; a Markdown image is refused, since an image is a block. Example:

Welcome

Start with the intro, then read the notes.

Why it works

Short lessons stick.

The guide: https://api.sherpo.io/merchant/docs/text. - [Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers `conflict` on `items`, and a license that is not active `conflict` on `status`.](https://docs.sherpo.io/merchant-api/reference/activate-license/index.md) - [Approves a pending request: the buyer is granted what they asked for, on the seats their order holds.](https://docs.sherpo.io/merchant-api/reference/approve-product-request/index.md) - [Stops a discount from applying while keeping it.](https://docs.sherpo.io/merchant-api/reference/archive-discount/index.md) - [Stops offering a price while keeping it for its buyers.](https://docs.sherpo.io/merchant-api/reference/archive-price/index.md) - [Attaches a file to a resource in a role.](https://docs.sherpo.io/merchant-api/reference/attach-asset/index.md) - [Applies a discount to a product, tier or price.](https://docs.sherpo.io/merchant-api/reference/attach-discount/index.md) - [Runs one bulk-capable change over many rows in one transaction, answering each item's outcome.](https://docs.sherpo.io/merchant-api/reference/bulk/index.md) - [Reads the calls customers' apps made to the store over the API and MCP over a period, by channel and client.](https://docs.sherpo.io/merchant-api/reference/call-stats/index.md) - [Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.](https://docs.sherpo.io/merchant-api/reference/cancel-event/index.md) - [Cancels a plan switch scheduled for the period's end, so the plan renews as it is. A store slot's removal is cancelled on its own. Only a member with full access cancels it.](https://docs.sherpo.io/merchant-api/reference/cancel-plan-change/index.md) - [Cancels a subscription now or at the end of its period.](https://docs.sherpo.io/merchant-api/reference/cancel-subscription/index.md) - [Cancels an upload that was never completed.](https://docs.sherpo.io/merchant-api/reference/cancel-upload/index.md) - [Counts the store's products by status.](https://docs.sherpo.io/merchant-api/reference/catalog-stats/index.md) - [Reads a product's certificate issues over a period.](https://docs.sherpo.io/merchant-api/reference/certificate-stats/index.md) - [Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.](https://docs.sherpo.io/merchant-api/reference/change-plan/index.md) - [Checks the store's own domain at Cloudflare now, making it the store's main address once its records check out while the plan includes a domain; a check moments after another answers the domain as last read.](https://docs.sherpo.io/merchant-api/reference/check-domain/index.md) - [Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.](https://docs.sherpo.io/merchant-api/reference/check-in-event-attendee/index.md) - [Says whether a path is free for a page or redirect.](https://docs.sherpo.io/merchant-api/reference/check-path/index.md) - [Removes a tier requirement from a resource.](https://docs.sherpo.io/merchant-api/reference/clear-access-requirement/index.md) - [Clears a customer's attempts at an entry's quizzes.](https://docs.sherpo.io/merchant-api/reference/clear-attempts/index.md) - [Reads commission totals over a period.](https://docs.sherpo.io/merchant-api/reference/commission-stats/index.md) - [Marks an upload done once its bytes are in place.](https://docs.sherpo.io/merchant-api/reference/complete-upload/index.md) - [Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.](https://docs.sherpo.io/merchant-api/reference/confirm-plan-change/index.md) - [Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.](https://docs.sherpo.io/merchant-api/reference/connect-domain/index.md) - [Reads the store's product views, checkouts started and orders over a period, by channel and product.](https://docs.sherpo.io/merchant-api/reference/conversion-stats/index.md) - [Creates a link file, such as an external video.](https://docs.sherpo.io/merchant-api/reference/create-asset/index.md) - [Creates an automation; an unlock needs customer:write too, a price adjustment discount:write, and each needs the read scope of what it names.](https://docs.sherpo.io/merchant-api/reference/create-automation/index.md) - [Creates a certificate for a product.](https://docs.sherpo.io/merchant-api/reference/create-certificate/index.md) - [Creates a discount.](https://docs.sherpo.io/merchant-api/reference/create-discount/index.md) - [Creates a draft entry in a product.](https://docs.sherpo.io/merchant-api/reference/create-entry/index.md) - [Adds a session to an event, with its start, end, time zone and place.](https://docs.sherpo.io/merchant-api/reference/create-event-session/index.md) - [Uploads a file of at most 2 MiB with its bytes in the call, for a client that cannot send them to an upload URL.](https://docs.sherpo.io/merchant-api/reference/create-inline-upload/index.md) - [Creates a customer notification for an event.](https://docs.sherpo.io/merchant-api/reference/create-notification/index.md) - [Creates a draft custom page.](https://docs.sherpo.io/merchant-api/reference/create-page/index.md) - [Adds a price to a product's tier.](https://docs.sherpo.io/merchant-api/reference/create-price/index.md) - [Adds a registration question to a product, its own or a standard detail: a text, a select or a checkbox, required or not.](https://docs.sherpo.io/merchant-api/reference/create-product-question/index.md) - [Creates a draft product.](https://docs.sherpo.io/merchant-api/reference/create-product/index.md) - [Adds an MCP prompt to a product.](https://docs.sherpo.io/merchant-api/reference/create-prompt/index.md) - [Creates a quiz on an entry.](https://docs.sherpo.io/merchant-api/reference/create-quiz/index.md) - [Creates a redirect from a path.](https://docs.sherpo.io/merchant-api/reference/create-redirect/index.md) - [Revokes a customer's access to a purchase's products, or a grant's, for cause: their access ends at once, their subscriptions to them stop, the customer is mailed with an optional message, and an optional refund is sent through Stripe or recorded.](https://docs.sherpo.io/merchant-api/reference/create-revocation/index.md) - [Adds an entry section to a product.](https://docs.sherpo.io/merchant-api/reference/create-section/index.md) - [Adds a tier to a product, with the settings its category takes, such as the features a software tier's licenses unlock.](https://docs.sherpo.io/merchant-api/reference/create-tier/index.md) - [Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.](https://docs.sherpo.io/merchant-api/reference/create-upload/index.md) - [Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.](https://docs.sherpo.io/merchant-api/reference/create-webhook/index.md) - [Reads the store's customer stats over a period.](https://docs.sherpo.io/merchant-api/reference/customer-stats/index.md) - [Frees one of a license's devices, so it stops counting toward the activation limit, whatever the license's status.](https://docs.sherpo.io/merchant-api/reference/deactivate-license-activation/index.md) - [Frees a device of a software product's license from the seller's server, whatever the license's status, an inactive one too; a device never activated, or already freed, answers `not_found`.](https://docs.sherpo.io/merchant-api/reference/deactivate-license/index.md) - [Declines a pending request or a waitlist place, giving back any seats it holds.](https://docs.sherpo.io/merchant-api/reference/decline-product-request/index.md) - [Deletes a file nothing uses.](https://docs.sherpo.io/merchant-api/reference/delete-asset/index.md) - [Deletes one quiz attempt.](https://docs.sherpo.io/merchant-api/reference/delete-attempt/index.md) - [Deletes an automation.](https://docs.sherpo.io/merchant-api/reference/delete-automation/index.md) - [Deletes a certificate never issued.](https://docs.sherpo.io/merchant-api/reference/delete-certificate/index.md) - [Deletes a discount no payable checkout, unpaid commission or automation relies on.](https://docs.sherpo.io/merchant-api/reference/delete-discount/index.md) - [Deletes an entry.](https://docs.sherpo.io/merchant-api/reference/delete-entry/index.md) - [Takes a session off an event's schedule.](https://docs.sherpo.io/merchant-api/reference/delete-event-session/index.md) - [Deletes one of a video's or audio file's AI outputs.](https://docs.sherpo.io/merchant-api/reference/delete-media-output/index.md) - [Deletes a notification; the store's defaults are turned off instead.](https://docs.sherpo.io/merchant-api/reference/delete-notification/index.md) - [Deletes a custom page.](https://docs.sherpo.io/merchant-api/reference/delete-page/index.md) - [Deletes a price no order or subscription refers to.](https://docs.sherpo.io/merchant-api/reference/delete-price/index.md) - [Stops asking a product question, dropping its answers.](https://docs.sherpo.io/merchant-api/reference/delete-product-question/index.md) - [Deletes a product no order, grant or subscription refers to.](https://docs.sherpo.io/merchant-api/reference/delete-product/index.md) - [Deletes an MCP prompt.](https://docs.sherpo.io/merchant-api/reference/delete-prompt/index.md) - [Deletes a quiz.](https://docs.sherpo.io/merchant-api/reference/delete-quiz/index.md) - [Deletes a redirect.](https://docs.sherpo.io/merchant-api/reference/delete-redirect/index.md) - [Deletes a release, with its files, or a note.](https://docs.sherpo.io/merchant-api/reference/delete-software-event/index.md) - [Deletes a tier no price or holder refers to.](https://docs.sherpo.io/merchant-api/reference/delete-tier/index.md) - [Deletes a webhook endpoint and its delivery history.](https://docs.sherpo.io/merchant-api/reference/delete-webhook/index.md) - [Detaches a file from a resource, keeping the file.](https://docs.sherpo.io/merchant-api/reference/detach-attachment/index.md) - [Stops a discount applying to a product, tier or price.](https://docs.sherpo.io/merchant-api/reference/detach-discount/index.md) - [Stops a license from checking as valid, whatever its holder's access.](https://docs.sherpo.io/merchant-api/reference/disable-license/index.md) - [Discards the staged body, keeping the published one.](https://docs.sherpo.io/merchant-api/reference/discard-staged/index.md) - [Stops selling a product while keeping it for its holders.](https://docs.sherpo.io/merchant-api/reference/discontinue-product/index.md) - [Counts the store's discounts by status.](https://docs.sherpo.io/merchant-api/reference/discount-stats/index.md) - [Updates, inserts, moves or deletes blocks of a body by id, without sending it whole. `getBodySchema` answers the props each block takes.](https://docs.sherpo.io/merchant-api/reference/edit-body/index.md) - [Lets a disabled license check as its holder's access says again.](https://docs.sherpo.io/merchant-api/reference/enable-license/index.md) - [Counts a product's entries by status and section.](https://docs.sherpo.io/merchant-api/reference/entry-stats/index.md) - [Erases a customer's personal data, keeping the records of what they bought.](https://docs.sherpo.io/merchant-api/reference/erase-customer/index.md) - [Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.](https://docs.sherpo.io/merchant-api/reference/event-attendee-stats/index.md) - [Counts an event's door: who is going, and each session with how many were let in.](https://docs.sherpo.io/merchant-api/reference/event-check-in-stats/index.md) - [Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.](https://docs.sherpo.io/merchant-api/reference/generate-media-output/index.md) - [Mints a short-lived URL to a file's bytes.](https://docs.sherpo.io/merchant-api/reference/get-asset-url/index.md) - [Reads one file.](https://docs.sherpo.io/merchant-api/reference/get-asset/index.md) - [Reads one quiz attempt with its answers.](https://docs.sherpo.io/merchant-api/reference/get-attempt/index.md) - [Reads one automation.](https://docs.sherpo.io/merchant-api/reference/get-automation/index.md) - [Reads the business's payout balance.](https://docs.sherpo.io/merchant-api/reference/get-balance/index.md) - [Answers what a save takes for a kind of body: its block types, each block's props with their types, values and limits, which are required, and where blocks may sit.](https://docs.sherpo.io/merchant-api/reference/get-body-schema/index.md) - [Reads one customer.](https://docs.sherpo.io/merchant-api/reference/get-customer/index.md) - [Reads one discount.](https://docs.sherpo.io/merchant-api/reference/get-discount/index.md) - [Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain.](https://docs.sherpo.io/merchant-api/reference/get-domain/index.md) - [Reads one entry.](https://docs.sherpo.io/merchant-api/reference/get-entry/index.md) - [Reads an event's cancellation and its refunds by status; null while the event stands.](https://docs.sherpo.io/merchant-api/reference/get-event-cancellation/index.md) - [Answers the bytes of a private file a capability names, to the bearer that asked for it.](https://docs.sherpo.io/merchant-api/reference/get-file/index.md) — The URL `POST /assets/{asset}/url` answers for a private file, or a download. Fetch it with the same bearer, before it is refreshed. - [Gets a license with its key, its status and the subscription behind it.](https://docs.sherpo.io/merchant-api/reference/get-license/index.md) - [Reads one of a video's or audio file's AI outputs with its content.](https://docs.sherpo.io/merchant-api/reference/get-media-output/index.md) - [Reads one business with its stores.](https://docs.sherpo.io/merchant-api/reference/get-merchant/index.md) - [Reads one order.](https://docs.sherpo.io/merchant-api/reference/get-order/index.md) - [Reads the store's business.](https://docs.sherpo.io/merchant-api/reference/get-organization/index.md) - [Reads one custom page.](https://docs.sherpo.io/merchant-api/reference/get-page/index.md) - [Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.](https://docs.sherpo.io/merchant-api/reference/get-plan-usage/index.md) - [Values a portfolio at live quotes and prices its watchlist.](https://docs.sherpo.io/merchant-api/reference/get-portfolio-valuation/index.md) - [Reads a portfolio product's book: settings, metrics and value.](https://docs.sherpo.io/merchant-api/reference/get-portfolio/index.md) - [Reads one product with its tiers and prices.](https://docs.sherpo.io/merchant-api/reference/get-product/index.md) - [Reads one of a product's MCP prompts.](https://docs.sherpo.io/merchant-api/reference/get-prompt/index.md) - [Reads one quiz with its questions.](https://docs.sherpo.io/merchant-api/reference/get-quiz/index.md) - [Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in.](https://docs.sherpo.io/merchant-api/reference/get-quota/index.md) - [Reads the store's settings.](https://docs.sherpo.io/merchant-api/reference/get-settings/index.md) - [Reads the store: its name, hostname, subdomain, branding and plan.](https://docs.sherpo.io/merchant-api/reference/get-store/index.md) - [Reads one subscription.](https://docs.sherpo.io/merchant-api/reference/get-subscription/index.md) - [Reads one webhook endpoint, never its secret.](https://docs.sherpo.io/merchant-api/reference/get-webhook/index.md) - [Grants a customer access to a product or tier.](https://docs.sherpo.io/merchant-api/reference/grant-access/index.md) - [Hides a review from the store.](https://docs.sherpo.io/merchant-api/reference/hide-review/index.md) - [Makes a price the one a product's page features.](https://docs.sherpo.io/merchant-api/reference/highlight-price/index.md) - [Issues a certificate to a customer.](https://docs.sherpo.io/merchant-api/reference/issue-certificate/index.md) - [Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.](https://docs.sherpo.io/merchant-api/reference/license-stats/index.md) - [Lists the tiers that unlock a product, entry, page or file.](https://docs.sherpo.io/merchant-api/reference/list-access-requirements/index.md) - [Pages the payouts recorded to affiliates.](https://docs.sherpo.io/merchant-api/reference/list-affiliate-payouts/index.md) - [Pages the store's affiliates by discount.](https://docs.sherpo.io/merchant-api/reference/list-affiliates/index.md) - [Pages the store's automations.](https://docs.sherpo.io/merchant-api/reference/list-all-automations/index.md) - [Lists the files announced with a holding.](https://docs.sherpo.io/merchant-api/reference/list-announced-files/index.md) - [Pages the deliveries of files from the last year, newest first, with the file, who it went to and its state, in the store's time zone.](https://docs.sherpo.io/merchant-api/reference/list-asset-deliveries/index.md) - [Pages where files are used.](https://docs.sherpo.io/merchant-api/reference/list-asset-uses/index.md) - [Pages the store's files.](https://docs.sherpo.io/merchant-api/reference/list-assets/index.md) - [Lists the files attached to a resource.](https://docs.sherpo.io/merchant-api/reference/list-attachments/index.md) - [Pages customers' quiz attempts.](https://docs.sherpo.io/merchant-api/reference/list-attempts/index.md) - [Pages the runs of automations.](https://docs.sherpo.io/merchant-api/reference/list-automation-runs/index.md) - [Lists the product categories the store may use.](https://docs.sherpo.io/merchant-api/reference/list-categories/index.md) - [Pages the certificates issued to customers.](https://docs.sherpo.io/merchant-api/reference/list-certificate-issues/index.md) - [Pages a product's certificates.](https://docs.sherpo.io/merchant-api/reference/list-certificates/index.md) - [Lists the events with a session held in person still to run or ended in the last 12 hours, soonest first, each with who is going and how many were let in.](https://docs.sherpo.io/merchant-api/reference/list-check-in-events/index.md) - [Pages the store's checkouts.](https://docs.sherpo.io/merchant-api/reference/list-checkouts/index.md) - [Pages the commissions affiliates earned.](https://docs.sherpo.io/merchant-api/reference/list-commissions/index.md) - [Pages customers' activity over a period.](https://docs.sherpo.io/merchant-api/reference/list-customer-activity/index.md) - [Reads a customer's answers to each product's registration questions, latest answered first.](https://docs.sherpo.io/merchant-api/reference/list-customer-answers/index.md) - [Pages the store's customers.](https://docs.sherpo.io/merchant-api/reference/list-customers/index.md) - [Pages the store's discounts.](https://docs.sherpo.io/merchant-api/reference/list-discounts/index.md) - [Pages what customers may reach, as their grants and subscriptions add up.](https://docs.sherpo.io/merchant-api/reference/list-entitlements/index.md) - [Pages a product's entries, a blog's drafts first then newest first, a podcast's newest first, unless sorted.](https://docs.sherpo.io/merchant-api/reference/list-entries/index.md) - [Pages a product's entries, each read whole, a blog's drafts first then newest first, a podcast's newest first, unless sorted.](https://docs.sherpo.io/merchant-api/reference/list-entry-details/index.md) - [Pages the distinct sections a product's entries hold, with how many hold each.](https://docs.sherpo.io/merchant-api/reference/list-entry-sections/index.md) - [Pages the distinct tags a product's entries hold, with how many hold each.](https://docs.sherpo.io/merchant-api/reference/list-entry-tags/index.md) - [Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket.](https://docs.sherpo.io/merchant-api/reference/list-event-attendees/index.md) - [Pages a canceled event's refunds: what each gives back, where it stands, and why one failed.](https://docs.sherpo.io/merchant-api/reference/list-event-refunds/index.md) - [Pages an event's sessions, earliest first.](https://docs.sherpo.io/merchant-api/reference/list-event-sessions/index.md) - [Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.](https://docs.sherpo.io/merchant-api/reference/list-feeds/index.md) - [Pages the grants of access to customers.](https://docs.sherpo.io/merchant-api/reference/list-grants/index.md) - [Pages a portfolio's holdings.](https://docs.sherpo.io/merchant-api/reference/list-holdings/index.md) - [Lists the store's integrations and their settings.](https://docs.sherpo.io/merchant-api/reference/list-integrations/index.md) - [Pages the devices a license counts, latest activated first, with those freed or gone inactive, never their instance ids.](https://docs.sherpo.io/merchant-api/reference/list-license-activations/index.md) - [Lists the store's published Ed25519 keys as JSON Web Keys, which software checks offline license tokens against: the one that signs, the next one, and those rotated out while a token they signed may live.](https://docs.sherpo.io/merchant-api/reference/list-license-signing-keys/index.md) - [Pages a software product's licenses, their keys shortened to their last characters.](https://docs.sherpo.io/merchant-api/reference/list-licenses/index.md) - [Lists a video's or audio file's AI outputs (subtitles, transcript, summary, chapters) and where each one's generation stands.](https://docs.sherpo.io/merchant-api/reference/list-media-outputs/index.md) - [Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.](https://docs.sherpo.io/merchant-api/reference/list-merchants/index.md) - [Pages the store's customer notifications.](https://docs.sherpo.io/merchant-api/reference/list-notifications/index.md) - [Pages the affiliate commissions an order earned.](https://docs.sherpo.io/merchant-api/reference/list-order-affiliates/index.md) - [Pages an order's lines.](https://docs.sherpo.io/merchant-api/reference/list-order-items/index.md) - [Pages an order's refunds.](https://docs.sherpo.io/merchant-api/reference/list-order-refunds/index.md) - [Pages an order's settlements.](https://docs.sherpo.io/merchant-api/reference/list-order-settlements/index.md) - [Pages the store's orders.](https://docs.sherpo.io/merchant-api/reference/list-orders/index.md) - [Pages the store's custom pages.](https://docs.sherpo.io/merchant-api/reference/list-pages/index.md) - [Lists the business's payouts.](https://docs.sherpo.io/merchant-api/reference/list-payouts/index.md) - [Pages a portfolio's events: trades, cash and notes.](https://docs.sherpo.io/merchant-api/reference/list-portfolio-events/index.md) - [Pages a portfolio's daily snapshots.](https://docs.sherpo.io/merchant-api/reference/list-portfolio-snapshots/index.md) - [Pages the prices of the store's products, or of one product.](https://docs.sherpo.io/merchant-api/reference/list-prices/index.md) - [Pages customers' quiz attempts.](https://docs.sherpo.io/merchant-api/reference/list-product-attempts/index.md) - [Pages the certificates issued to customers.](https://docs.sherpo.io/merchant-api/reference/list-product-certificate-issues/index.md) - [Pages a product's customers.](https://docs.sherpo.io/merchant-api/reference/list-product-customers/index.md) - [Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.](https://docs.sherpo.io/merchant-api/reference/list-product-feeds/index.md) - [Pages the prices of the store's products, or of one product.](https://docs.sherpo.io/merchant-api/reference/list-product-prices/index.md) - [Pages the registration questions a product asks its buyers in checkout, in order.](https://docs.sherpo.io/merchant-api/reference/list-product-questions/index.md) - [Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.](https://docs.sherpo.io/merchant-api/reference/list-product-requests/index.md) - [Pages the store's product reviews.](https://docs.sherpo.io/merchant-api/reference/list-product-reviews/index.md) - [Pages the tiers of the store's products, or of one product.](https://docs.sherpo.io/merchant-api/reference/list-product-tiers/index.md) - [Pages the store's products.](https://docs.sherpo.io/merchant-api/reference/list-products/index.md) - [Pages a product's MCP prompts with their text.](https://docs.sherpo.io/merchant-api/reference/list-prompts/index.md) - [Pages an entry's quizzes.](https://docs.sherpo.io/merchant-api/reference/list-quizzes/index.md) - [Pages the store's redirects.](https://docs.sherpo.io/merchant-api/reference/list-redirects/index.md) - [Reads the access requirements of many resources at once.](https://docs.sherpo.io/merchant-api/reference/list-resource-access/index.md) - [Pages the store's product reviews.](https://docs.sherpo.io/merchant-api/reference/list-reviews/index.md) - [Pages the revocations of customers' access for cause, of one customer or one order when named, with each one's refund.](https://docs.sherpo.io/merchant-api/reference/list-revocations/index.md) - [Lists a product's entry sections.](https://docs.sherpo.io/merchant-api/reference/list-sections/index.md) - [Pages a software product's releases and notes, newest first.](https://docs.sherpo.io/merchant-api/reference/list-software-events/index.md) - [Pages the billing periods of subscriptions.](https://docs.sherpo.io/merchant-api/reference/list-subscription-periods/index.md) - [Pages the status changes of subscriptions.](https://docs.sherpo.io/merchant-api/reference/list-subscription-transitions/index.md) - [Pages the store's subscriptions.](https://docs.sherpo.io/merchant-api/reference/list-subscriptions/index.md) - [Pages the tiers of the store's products, or of one product.](https://docs.sherpo.io/merchant-api/reference/list-tiers/index.md) - [Pages a webhook endpoint's recent deliveries: status, attempts and last response code.](https://docs.sherpo.io/merchant-api/reference/list-webhook-deliveries/index.md) - [Pages the store's webhook endpoints.](https://docs.sherpo.io/merchant-api/reference/list-webhooks/index.md) - [Moves a file between public and private storage.](https://docs.sherpo.io/merchant-api/reference/move-asset/index.md) - [Reads the store's order totals over a period of any length, against the span before it.](https://docs.sherpo.io/merchant-api/reference/order-stats/index.md) - [Pauses an automation.](https://docs.sherpo.io/merchant-api/reference/pause-automation/index.md) - [Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.](https://docs.sherpo.io/merchant-api/reference/preview-plan-change/index.md) - [Previews what one more store on the business's plan charges now and bills from its next renewal.](https://docs.sherpo.io/merchant-api/reference/preview-plan-store/index.md) - [Counts a product's customers by status.](https://docs.sherpo.io/merchant-api/reference/product-customer-stats/index.md) - [Counts a product's files and links by kind.](https://docs.sherpo.io/merchant-api/reference/product-file-stats/index.md) - [Reads review counts and ratings.](https://docs.sherpo.io/merchant-api/reference/product-review-stats/index.md) - [Reads a product's sales and audience stats over a period.](https://docs.sherpo.io/merchant-api/reference/product-stats/index.md) - [Reads the short summaries of up to a page of products by id, with where each stands.](https://docs.sherpo.io/merchant-api/reference/product-summaries/index.md) - [Reads a product's views, visitors, checkouts started and orders over a period, by channel.](https://docs.sherpo.io/merchant-api/reference/product-traffic-stats/index.md) - [Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.](https://docs.sherpo.io/merchant-api/reference/promote-product-request/index.md) - [Publishes the staged body.](https://docs.sherpo.io/merchant-api/reference/publish-body/index.md) - [Publishes an entry now or schedules it.](https://docs.sherpo.io/merchant-api/reference/publish-entry/index.md) - [Publishes one of a video's or audio file's AI outputs to customers, or takes it back to a draft.](https://docs.sherpo.io/merchant-api/reference/publish-media-output/index.md) - [Publishes a custom page now or schedules it.](https://docs.sherpo.io/merchant-api/reference/publish-page/index.md) - [Publishes a product now or schedules it.](https://docs.sherpo.io/merchant-api/reference/publish-product/index.md) - [Reads a product's quiz results.](https://docs.sherpo.io/merchant-api/reference/quiz-stats/index.md) - [Reads the latest quotes for symbols.](https://docs.sherpo.io/merchant-api/reference/quote-symbols/index.md) - [Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. `getBodySchema` answers the blocks and props each kind of body takes.](https://docs.sherpo.io/merchant-api/reference/read-body/index.md) - [Records a payout made to an affiliate.](https://docs.sherpo.io/merchant-api/reference/record-affiliate-payout/index.md) - [Records a key a customer holds from another platform as their license to a software product, so software in the field keeps checking; it may land disabled, or take the place of the customer's license.](https://docs.sherpo.io/merchant-api/reference/record-license/index.md) - [Records an order paid outside the store, granting what it bought.](https://docs.sherpo.io/merchant-api/reference/record-order/index.md) - [Records a trade, cash movement or note in a portfolio.](https://docs.sherpo.io/merchant-api/reference/record-portfolio-event/index.md) - [Records a refund of an order, optionally revoking what it granted.](https://docs.sherpo.io/merchant-api/reference/record-refund/index.md) - [Records a release, whose files become the current download, or a note on a software product.](https://docs.sherpo.io/merchant-api/reference/record-software-event/index.md) - [Answers a fresh signed token for a device a software product's active license counts, from the seller's server, stamping the device seen; a license that is not active answers `conflict` on `status`, and a device it does not count (never activated, freed or gone inactive) `not_found`.](https://docs.sherpo.io/merchant-api/reference/refresh-license-token/index.md) - [Sells a discontinued product again.](https://docs.sherpo.io/merchant-api/reference/reinstate-product/index.md) - [Shows an unlisted product in the store's listings again.](https://docs.sherpo.io/merchant-api/reference/relist-product/index.md) - [Removes an affiliate from a discount, or ends one that earned commissions, which stay.](https://docs.sherpo.io/merchant-api/reference/remove-affiliate/index.md) - [Stops serving the store on its own domain, or dismisses one that was let go; its Sherpo address becomes its main address again. Answers not found when the store has no domain, as after a removal that already landed.](https://docs.sherpo.io/merchant-api/reference/remove-domain/index.md) - [Removes a product's entry section, its entries kept outside any section.](https://docs.sherpo.io/merchant-api/reference/remove-section/index.md) - [Renames a product's entry section.](https://docs.sherpo.io/merchant-api/reference/rename-section/index.md) - [Sets the order of a resource's attachments.](https://docs.sherpo.io/merchant-api/reference/reorder-attachments/index.md) - [Sets the order of a product's entries.](https://docs.sherpo.io/merchant-api/reference/reorder-entries/index.md) - [Sets the order of a product's tiers.](https://docs.sherpo.io/merchant-api/reference/reorder-tiers/index.md) - [Replaces a file's bytes with another upload's, keeping where it is used and deleting a video's or audio file's AI outputs.](https://docs.sherpo.io/merchant-api/reference/replace-asset/index.md) - [Sets or clears the store's reply to a review.](https://docs.sherpo.io/merchant-api/reference/reply-to-review/index.md) - [Sends a delivery's event to its endpoint again, with the same event id; needs the read scopes its payload carries.](https://docs.sherpo.io/merchant-api/reference/resend-webhook-delivery/index.md) - [Lets an archived discount apply again.](https://docs.sherpo.io/merchant-api/reference/restore-discount/index.md) - [Offers an archived price again.](https://docs.sherpo.io/merchant-api/reference/restore-price/index.md) - [Sets the products, tiers or prices a discount applies to.](https://docs.sherpo.io/merchant-api/reference/restrict-discount/index.md) - [Resumes a paused automation; an unlock needs customer:write too, a price adjustment discount:write.](https://docs.sherpo.io/merchant-api/reference/resume-automation/index.md) - [Withdraws a subscription's scheduled cancellation.](https://docs.sherpo.io/merchant-api/reference/resume-subscription/index.md) - [Tries a canceled event's failed refund again.](https://docs.sherpo.io/merchant-api/reference/retry-event-refund/index.md) - [Sends a revocation's failed Stripe refund again.](https://docs.sherpo.io/merchant-api/reference/retry-revocation-refund/index.md) - [Puts back the commission an affiliate had before an API token that did not make it changed it.](https://docs.sherpo.io/merchant-api/reference/revert-affiliate/index.md) - [Reads review counts and ratings.](https://docs.sherpo.io/merchant-api/reference/review-stats/index.md) - [Revokes an issued certificate.](https://docs.sherpo.io/merchant-api/reference/revoke-certificate-issue/index.md) - [Stops a customer's private feed of a blog, a podcast or an event.](https://docs.sherpo.io/merchant-api/reference/revoke-feed/index.md) - [Revokes a grant of access.](https://docs.sherpo.io/merchant-api/reference/revoke-grant/index.md) - [Replaces a webhook endpoint's signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.](https://docs.sherpo.io/merchant-api/reference/roll-webhook-secret/index.md) - [Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with `retire_previous` every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With `current`, a rotation since answers `conflict`. A store with no keys gets its first set.](https://docs.sherpo.io/merchant-api/reference/rotate-license-signing-keys/index.md) - [Gives a license a fresh key and emails it to the holder; the old key stops checking at once.](https://docs.sherpo.io/merchant-api/reference/rotate-license/index.md) - [Searches the market for symbols by name or ticker.](https://docs.sherpo.io/merchant-api/reference/search-symbols/index.md) - [Requires a tier to unlock a resource.](https://docs.sherpo.io/merchant-api/reference/set-access-requirement/index.md) - [Makes a user an affiliate of a discount, with their commission.](https://docs.sherpo.io/merchant-api/reference/set-affiliate/index.md) - [Turns on or off adding Pro's add-on blocks on their own: when a store's storage or AI media minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what's covered. On by default for new businesses.](https://docs.sherpo.io/merchant-api/reference/set-auto-add-ons/index.md) - [Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.](https://docs.sherpo.io/merchant-api/reference/set-auto-upgrade/index.md) - [Writes the live body of the store's home, a page, a product or an entry, or with `staged: true` its unpublished next body, which `publishBody` publishes; `from` names the body read, so a write over one changed since is refused. Ask `getBodySchema` for the blocks, props and values its kind takes before writing: anything else is refused, naming the block, the prop and what it takes.](https://docs.sherpo.io/merchant-api/reference/set-body/index.md) - [Answers a product's registration questions for a customer who holds it, such as answers they gave elsewhere.](https://docs.sherpo.io/merchant-api/reference/set-customer-answers/index.md) - [Sets or clears an integration's settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.](https://docs.sherpo.io/merchant-api/reference/set-integration/index.md) - [Sets or clears the business's logo from a file.](https://docs.sherpo.io/merchant-api/reference/set-organization-logo/index.md) - [Sets, swaps or clears a product's thumbnail, its first poster, if it is still the one the caller saw.](https://docs.sherpo.io/merchant-api/reference/set-product-poster/index.md) - [Sets or clears the store's icon from a file.](https://docs.sherpo.io/merchant-api/reference/set-store-icon/index.md) - [Prices each of a product's prices as the checkout would charge a customer, or a new one, with an optional coupon, quantity and later time, writing nothing; naming a customer needs `customer:read`, and a coupon `discount:read`.](https://docs.sherpo.io/merchant-api/reference/simulate-checkout/index.md) - [Reads the store's takings and audience stats over a period.](https://docs.sherpo.io/merchant-api/reference/store-stats/index.md) - [Reads the store's takings and audience totals since its first order.](https://docs.sherpo.io/merchant-api/reference/store-totals/index.md) - [Reads the store's subscription stats over a period.](https://docs.sherpo.io/merchant-api/reference/subscription-stats/index.md) - [Reads the store's views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.](https://docs.sherpo.io/merchant-api/reference/traffic-stats/index.md) - [Lets a customer hold a private feed of a blog, a podcast or an event again after repeated sharing turned it off, counting sharing afresh.](https://docs.sherpo.io/merchant-api/reference/unblock-feed/index.md) - [Takes back an attendee's check-in at an event's session.](https://docs.sherpo.io/merchant-api/reference/undo-event-attendee-check-in/index.md) - [Shows a hidden review again.](https://docs.sherpo.io/merchant-api/reference/unhide-review/index.md) - [Hides a product from the store's listings while keeping its page reachable.](https://docs.sherpo.io/merchant-api/reference/unlist-product/index.md) - [Takes an entry back to draft.](https://docs.sherpo.io/merchant-api/reference/unpublish-entry/index.md) - [Takes a custom page back to draft.](https://docs.sherpo.io/merchant-api/reference/unpublish-page/index.md) - [Takes a product back to draft.](https://docs.sherpo.io/merchant-api/reference/unpublish-product/index.md) - [Updates a file's name, title, description and security level.](https://docs.sherpo.io/merchant-api/reference/update-asset/index.md) - [Updates an attachment's role, delivery or preview flag.](https://docs.sherpo.io/merchant-api/reference/update-attachment/index.md) - [Updates an automation's trigger and action; a new trigger or action needs the scopes creating the rule would.](https://docs.sherpo.io/merchant-api/reference/update-automation/index.md) - [Updates a certificate's design and copy.](https://docs.sherpo.io/merchant-api/reference/update-certificate/index.md) - [Updates a discount's fields.](https://docs.sherpo.io/merchant-api/reference/update-discount/index.md) - [Updates an entry's fields.](https://docs.sherpo.io/merchant-api/reference/update-entry/index.md) - [Moves an event session or changes its place.](https://docs.sherpo.io/merchant-api/reference/update-event-session/index.md) - [Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.](https://docs.sherpo.io/merchant-api/reference/update-feed/index.md) - [Updates a holding's note.](https://docs.sherpo.io/merchant-api/reference/update-holding/index.md) - [Sets a license's activation limit, its uses or its metadata.](https://docs.sherpo.io/merchant-api/reference/update-license/index.md) - [Edits one of a video's or audio file's AI outputs: the subtitles' cues, or the transcript's, summary's or chapters' content.](https://docs.sherpo.io/merchant-api/reference/update-media-output/index.md) - [Updates whether a notification is enabled.](https://docs.sherpo.io/merchant-api/reference/update-notification/index.md) - [Updates the business's name and details.](https://docs.sherpo.io/merchant-api/reference/update-organization/index.md) - [Updates a custom page's fields.](https://docs.sherpo.io/merchant-api/reference/update-page/index.md) - [Updates a portfolio's settings.](https://docs.sherpo.io/merchant-api/reference/update-portfolio/index.md) - [Updates a price's fields.](https://docs.sherpo.io/merchant-api/reference/update-price/index.md) - [Rewords a product question, makes it required or not, changes its options or pattern, or moves it.](https://docs.sherpo.io/merchant-api/reference/update-product-question/index.md) - [Updates a product's fields.](https://docs.sherpo.io/merchant-api/reference/update-product/index.md) - [Updates an MCP prompt's fields, text or access.](https://docs.sherpo.io/merchant-api/reference/update-prompt/index.md) - [Updates a quiz's settings and questions.](https://docs.sherpo.io/merchant-api/reference/update-quiz/index.md) - [Updates a redirect's source or destination.](https://docs.sherpo.io/merchant-api/reference/update-redirect/index.md) - [Updates the store's settings.](https://docs.sherpo.io/merchant-api/reference/update-settings/index.md) - [Updates a release's version, notes, files or tier, or a note.](https://docs.sherpo.io/merchant-api/reference/update-software-event/index.md) - [Updates the store's name, description and branding.](https://docs.sherpo.io/merchant-api/reference/update-store/index.md) - [Renames a tier or changes its settings, such as the features a software tier's licenses unlock.](https://docs.sherpo.io/merchant-api/reference/update-tier/index.md) - [Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.](https://docs.sherpo.io/merchant-api/reference/update-webhook/index.md) - [Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with `count_use` an active one counts a use, and with `instance` it reads and stamps that device. An unknown key, or another product's, answers `not_found`.](https://docs.sherpo.io/merchant-api/reference/verify-license/index.md) ## Sections - [Tags](https://docs.sherpo.io/merchant-api/reference/tags/llms.txt)