| Tool | What it does | Scope | |
|---|
bulk | Runs one bulk-capable change over many rows in one transaction, answering each item's outcome | any | write |
list_categories | Lists the product categories the store may use | product:read | read |
list_products | Pages the store's products | product:read | read |
get_product | Reads one product with its tiers and prices | product:read | read |
product_summaries | Reads the short summaries of up to a page of products by id | product:read | read |
create_product | Creates a draft product | product:write | write |
update_product | Updates a product's fields | product:write | write |
publish_product | Publishes a product now or schedules it | product:write | write |
unpublish_product | Takes a product back to draft | product:write | write |
discontinue_product | Stops selling a product while keeping it for its holders | product:write | write |
reinstate_product | Sells a discontinued product again | product:write | write |
unlist_product | Hides a product from the store's listings while keeping its page reachable | product:write | write |
relist_product | Shows an unlisted product in the store's listings again | product:write | write |
delete_product | Deletes a product no order, grant or subscription refers to | product:delete | write |
list_tiers | Pages the tiers of the store's products, or of one product | product:read | read |
create_tier | Adds a tier to a product | product:write | write |
update_tier | Renames a tier | product:write | write |
reorder_tiers | Sets the order of a product's tiers | product:write | write |
delete_tier | Deletes a tier no price or holder refers to | product:delete | write |
list_prices | Pages the prices of the store's products, or of one product | price:read | read |
create_price | Adds a price to a product's tier | price:write | write |
update_price | Updates a price's fields | price:write | write |
highlight_price | Makes a price the one a product's page features | price:write | write |
archive_price | Stops offering a price while keeping it for its buyers | price:write | write |
restore_price | Offers an archived price again | price:write | write |
delete_price | Deletes a price no order or subscription refers to | price:delete | write |
list_entries | Pages a product's entries | subpage:read | read |
list_entry_details | Pages a product's entries, each read whole | subpage:read | read |
get_entry | Reads one entry | subpage:read | read |
entry_stats | Counts a product's entries by status and section | subpage:read | read |
create_entry | Creates a draft entry in a product | subpage:write | write |
update_entry | Updates an entry's fields | subpage:write | write |
publish_entry | Publishes an entry now or schedules it | subpage:write | write |
unpublish_entry | Takes an entry back to draft | subpage:write | write |
reorder_entries | Sets the order of a product's entries | subpage:write | write |
list_sections | Lists a product's entry sections | subpage:read | read |
create_section | Adds an entry section to a product | subpage:write | write |
rename_section | Renames a product's entry section | subpage:write | write |
remove_section | Removes a product's entry section, its entries kept outside any section | subpage:write | write |
delete_entry | Deletes an entry | subpage:delete | write |
list_pages | Pages the store's custom pages | custompage:read | read |
get_page | Reads one custom page | custompage:read | read |
create_page | Creates a draft custom page | custompage:write | write |
update_page | Updates a custom page's fields | custompage:write | write |
publish_page | Publishes a custom page now or schedules it | custompage:write | write |
unpublish_page | Takes a custom page back to draft | custompage:write | write |
delete_page | Deletes a custom page | custompage:delete | write |
list_attachments | Lists the files attached to a resource | file:read | read |
read_body | Reads a product's, entry's, page's or quiz's body, published and staged | file:read | read |
set_body | Stages a new body for a product, entry, page or quiz | file:write | write |
publish_body | Publishes the staged body | file:write | write |
discard_staged | Discards the staged body, keeping the published one | file:write | write |
attach_asset | Attaches a file to a resource in a role | file:write | write |
update_attachment | Updates an attachment's role, delivery or preview flag | file:write | write |
reorder_attachments | Sets the order of a resource's attachments | file:write | write |
detach_attachment | Detaches a file from a resource, keeping the file | file:write | write |
list_prompts | Pages a product's MCP prompts with their text; needs product:read too | file:read | read |
get_prompt | Reads one of a product's MCP prompts; needs product:read too | file:read | read |
create_prompt | Adds an MCP prompt to a product; needs product:write too | file:write | write |
update_prompt | Updates an MCP prompt's fields, text or access; needs product:write too | file:write | write |
delete_prompt | Deletes an MCP prompt; needs product:write too | file:delete | write |
set_product_poster | Sets, swaps or clears a product's thumbnail, its first poster, if it is still the one the caller saw; needs product:write too | file:write | write |
list_access_requirements | Lists the tiers that unlock a product, entry, page or file | product:read | read |
list_resource_access | Reads the access requirements of many resources at once | product:read | read |
set_access_requirement | Requires a tier to unlock a resource | product:write | write |
clear_access_requirement | Removes a tier requirement from a resource | product:write | write |
list_assets | Pages the store's files | file:read | read |
get_asset | Reads one file | file:read | read |
get_quota | Reads the store's storage use against its plan's allowance | file:read | read |
create_asset | Creates a link file, such as an external video | file:write | write |
create_upload | Reserves a file and answers where to upload its bytes | file:write | write |
complete_upload | Marks an upload done once its bytes are in place | file:write | write |
cancel_upload | Cancels an upload that was never completed | file:write | write |
get_asset_url | Mints a short-lived URL to a file's bytes | file:read | write |
update_asset | Updates a file's name, title and description | file:write | write |
record_asset_size | Records a file's measured pixel size or length, keeping its other metadata | file:write | write |
move_asset | Moves a file between public and private storage | file:write | write |
replace_asset | Replaces a file's bytes with another upload's, keeping where it is used | file:write | write |
delete_asset | Deletes a file nothing uses | file:delete | write |
store_stats | Reads the store's takings and audience stats over a period | transaction:read | read |
order_stats | Reads the store's order totals over a period | transaction:read | read |
customer_stats | Reads the store's customer stats over a period | customer:read | read |
subscription_stats | Reads the store's subscription stats over a period | subscription:read | read |
product_stats | Reads a product's sales and audience stats over a period | product:read | read |
catalog_stats | Counts the store's products by status | product:read | read |
product_file_stats | Counts a product's files and links by kind | file:read | read |
list_orders | Pages the store's orders | transaction:read | read |
get_order | Reads one order | transaction:read | read |
list_order_items | Pages an order's lines | transaction:read | read |
list_order_settlements | Pages an order's settlements | transaction:read | read |
list_order_refunds | Pages an order's refunds | transaction:read | read |
list_order_affiliates | Pages the affiliate commissions an order earned | transaction:read | read |
record_refund | Records a refund of an order, optionally revoking what it granted | transaction:write | write |
record_order | Records an order paid outside the store, granting what it bought | transaction:write | write |
record_affiliate_payout | Records a payout made to an affiliate | affiliate:write | write |
list_commissions | Pages the commissions affiliates earned | affiliate:read | read |
commission_stats | Reads commission totals over a period | affiliate:read | read |
list_affiliate_payouts | Pages the payouts recorded to affiliates | affiliate:read | read |
list_discounts | Pages the store's discounts | discount:read | read |
get_discount | Reads one discount | discount:read | read |
discount_stats | Counts the store's discounts by status | discount:read | read |
create_discount | Creates a discount | discount:write | write |
update_discount | Updates a discount's fields | discount:write | write |
archive_discount | Stops a discount from applying while keeping it | discount:write | write |
restore_discount | Lets an archived discount apply again | discount:write | write |
delete_discount | Deletes a discount no order refers to | discount:delete | write |
list_affiliates | Pages the store's affiliates by discount | affiliate:read | read |
set_affiliate | Makes a user an affiliate of a discount, with their commission | affiliate:write | write |
remove_affiliate | Removes an affiliate from a discount | affiliate:write | write |
restrict_discount | Sets the products, tiers or prices a discount applies to | discount:write | write |
attach_discount | Applies a discount to a product, tier or price | discount:write | write |
detach_discount | Stops a discount applying to a product, tier or price | discount:write | write |
list_subscriptions | Pages the store's subscriptions | subscription:read | read |
list_subscription_periods | Pages the billing periods of subscriptions | subscription:read | read |
list_subscription_transitions | Pages the status changes of subscriptions | subscription:read | read |
get_subscription | Reads one subscription | subscription:read | read |
cancel_subscription | Cancels a subscription now or at the end of its period | subscription:write | write |
resume_subscription | Withdraws a subscription's scheduled cancellation | subscription:write | write |
list_grants | Pages the grants of access to customers | customer:read | read |
grant_access | Grants a customer access to a product or tier | customer:write | write |
revoke_grant | Revokes a grant of access | customer:write | write |
list_entitlements | Pages what customers may reach, as their grants and subscriptions add up | customer:read | read |
list_customers | Pages the store's customers | customer:read | read |
list_customer_activity | Pages customers' activity over a period | customer:read | read |
list_product_customers | Pages a product's customers | customer:read | read |
product_customer_stats | Counts a product's customers by status | customer:read | read |
list_checkouts | Pages the store's checkouts | customer:read | read |
get_customer | Reads one customer | customer:read | read |
erase_customer | Erases a customer's personal data, keeping the records of what they bought | customer:delete | write |
list_reviews | Pages the store's product reviews | review:read | read |
review_stats | Reads review counts and ratings | review:read | read |
hide_review | Hides a review from the store | review:moderate | write |
unhide_review | Shows a hidden review again | review:moderate | write |
reply_to_review | Sets or clears the store's reply to a review | review:write | write |
list_attempts | Pages customers' quiz attempts | quiz:read | read |
get_attempt | Reads one quiz attempt with its answers | quiz:read | read |
list_certificates | Pages the store's certificates | certificate:read | read |
list_certificate_issues | Pages the certificates issued to customers | certificate:read | read |
certificate_stats | Reads a product's certificate issues over a period | certificate:read | read |
list_asset_deliveries | Pages the deliveries of files to customers | file:read | read |
list_asset_uses | Pages where files are used | file:read | read |
issue_certificate | Issues a certificate to a customer | certificate:write | write |
list_quizzes | Pages an entry's quizzes | quiz:read | read |
get_quiz | Reads one quiz with its questions | quiz:read | read |
quiz_stats | Reads a product's quiz results | quiz:read | read |
create_quiz | Creates a quiz on an entry | quiz:write | write |
update_quiz | Updates a quiz's settings and questions | quiz:write | write |
delete_quiz | Deletes a quiz | quiz:delete | write |
clear_attempts | Clears a customer's attempts at an entry's quizzes | quiz:write | write |
delete_attempt | Deletes one quiz attempt | quiz:write | write |
create_certificate | Creates a certificate for a product | certificate:write | write |
update_certificate | Updates a certificate's design and copy | certificate:write | write |
delete_certificate | Deletes a certificate never issued | certificate:delete | write |
revoke_certificate_issue | Revokes an issued certificate | certificate:write | write |
get_store | Reads the store: its name, hostname, branding and plan | site:read | read |
get_settings | Reads the store's settings | site:read | read |
update_settings | Updates the store's settings | site:write | write |
update_store | Updates the store's name, description and branding | site:write | write |
set_store_icon | Sets or clears the store's icon from a file | site:write | write |
get_organization | Reads the store's business | organization:read | read |
update_organization | Updates the business's name and details | organization:write | write |
set_organization_logo | Sets or clears the business's logo from a file | organization:write | write |
get_balance | Reads the business's payout balance | organization:read | read |
list_payouts | Lists the business's payouts | organization:read | read |
list_notifications | Pages the store's customer notifications | organization:read | read |
create_notification | Creates a customer notification for an event | organization:write | write |
update_notification | Updates a notification's template or whether it is enabled | organization:write | write |
delete_notification | Deletes a notification | organization:write | write |
list_redirects | Pages the store's redirects | site:read | read |
create_redirect | Creates a redirect from a path | site:write | write |
update_redirect | Updates a redirect's source or destination | site:write | write |
delete_redirect | Deletes a redirect | site:write | write |
check_path | Says whether a path is free for a page or redirect | site:read | read |
list_integrations | Lists the store's integrations and their settings | integration:read | read |
set_integration | Sets or clears an integration's settings | integration:write | write |
list_all_automations | Pages the store's automations | automation:read | read |
list_automation_runs | Pages the runs of automations | automation:read | read |
get_automation | Reads one automation | automation:read | read |
create_automation | Creates an automation | automation:write | write |
update_automation | Updates an automation's trigger and action | automation:write | write |
pause_automation | Pauses an automation | automation:write | write |
resume_automation | Resumes a paused automation | automation:write | write |
delete_automation | Deletes an automation | automation:write | write |
get_portfolio | Reads a portfolio product's book: settings, metrics and value | portfolio:read | read |
list_holdings | Pages a portfolio's holdings | portfolio:read | read |
update_portfolio | Updates a portfolio's settings | portfolio:write | write |
update_holding | Updates a holding's name and note | portfolio:write | write |
list_announced_files | Lists the files announced with a holding | portfolio:read | read |
list_portfolio_events | Pages a portfolio's events: trades, cash and notes | portfolio:read | read |
record_portfolio_event | Records a trade, cash movement or note in a portfolio | portfolio:write | write |
list_portfolio_snapshots | Pages a portfolio's daily snapshots | portfolio:read | read |
search_symbols | Searches the market for symbols by name or ticker | portfolio:read | read |
quote_symbols | Reads the latest quotes for symbols | portfolio:read | read |
list_merchants | Lists the businesses the token may act for, with their stores | organization:read | read |
get_merchant | Reads one business with its stores | organization:read | read |