users.update and variants) call routes that are not in the public contract yet; see the SDK reference.
Interactive API explorer
/docs.json. This page is generated from the same public contract so the catalog does not drift from the deployed API. Every operation has a stable operationId you can use with OpenAPI code generators.
Conventions
- Base URL:
https://api.pocketsflow.com - Authentication:
Authorization: Bearer pk_live_...(live data) orAuthorization: Bearer pk_test_...(test data). The key decides the mode, not the dashboard toggle. - JSON requests use
Content-Type: application/json; file uploads usemultipart/form-data. - IDs are MongoDB ObjectId strings (24 hex characters). Payments-partner IDs such as
plan_...,pay_..., andmem_...keep their prefixes. - Money is a decimal amount in major currency units (
29.99), not cents. - Errors are JSON:
{ "message": "..." }, witherror(authentication errors) and sometimes a machine-readablecode. See Errors. - Every authenticated endpoint can also answer
401(invalid key),429(rate limited — 600 requests/minute per account) and500. - A write that turns on a feature the account’s plan does not include answers
403withcode: "FEATURE_LOCKED"(seeFeatureLockedand Plans and limits). CheckGET /users/entitlementsfirst. GET /orders,GET /paymentsandGET /delivered-webhooksare paginated withpageandpageSize(maximum 100); most other lists return everything in one response.
A/B tests
Split a product’s visitors between 2–4 versions of its price, headline, cover image or checkout layout, then keep the winner (Pro plan and above — starting a test below it answers403 FEATURE_LOCKED; reading, stopping,
declaring a winner and deleting never do). A paid sale is a conversion.
Full guide: A/B tests.
listAbTests, createAbTest, assignAbTestVariant,
getAbTest, deleteAbTest, getAbTestResults, stopAbTest,
declareAbTestWinner.
Account
Read the authenticated account, record what it sells and where buyers pay, and set its ad tracking pixelsGET /users/me
GET /users/me
subdomain to build storefront and product URLs.Operation ID: getCurrentUserResponsesPUT /users/selling-profile
PUT /users/selling-profile
GET /users/me returns: sellingPath (what they sell) and sellingSetup (pages: Pocketsflow creator and product pages, no code; code: their own site or app, with the embedded checkout, this API, the SDK or the MCP server). The dashboard shapes its first-sale steps around them. Send only what changes; null clears an answer. When the creator never answered (null on GET /users/me), ask them before choosing for them.Operation ID: updateSellingProfileRequest bodyContent type: application/jsonPOST /users/update
POST /users/update
null removes one. Each id must match its vendor’s format (400 with the offending field otherwise). Adding or changing a pixel needs the Starter plan or higher; removing one, or re-sending the saved value, never does. Returns the updated account. This endpoint also takes account settings the dashboard uses; only the fields below are part of the public contract.Operation ID: updateTrackingPixelsRequest bodyContent type: application/jsonAgencies
The agency partner program (free on every plan): build and run stores for clients from one login and earn 20% of each client’s Pocketsflow plan payments for 12 months. The/agency routes act on the API key owner’s own
agency; the /agency-access routes act on the key owner’s store. Full guide:
Agency partner program.
getAgency, createAgency, updateAgency,
listAgencyClients, removeAgencyClient, listAgencyStatements,
getAgencyStatement, getStoreAgency, previewAgency, inviteAgency,
removeStoreAgency.
POST /agency-access
POST /agency-access
GET /agency/clients
GET /agency/clients
earnedCents,
pendingCents inside the 14-day refund window) and when your 12 months end
(earnUntil), plus totals (clients, revenue30dCents,
earnedThisMonthCents, pendingCents, clearedCents, paidCents,
lifetimeCents).Affiliate tiers
Tiered affiliate commissions and milestone bonuses (Pro plan and above). A sale’s rate is decided when its checkout is created, from the affiliate’s paid, non-refunded sales in the period before this sale, and saved on the order (affiliateRate, affiliateTier). Bonuses are paid like commission,
through the regular affiliate payouts. Turning the program on or changing it
below Pro answers 403 FEATURE_LOCKED; { "enabled": false } and reads never
do. Full guide: Affiliate tiers.
getAffiliateTiers, updateAffiliateTiers,
listAffiliateTierProgress, getAffiliateTierProgress,
listAffiliateBonuses, getMyAffiliateTierProgress.
minSales is the number of sales before the sale: 10 applies from the
11th sale. Event: affiliate.tier_changed.
Analytics
Reports on your store: the sales funnel, revenue by source and UTM, repeat buyers, net revenue after refunds (Growth plan and above) and MRR (Pro plan and above). A lower plan gets403 FEATURE_LOCKED. Full guide:
Analytics API.
getAnalyticsPreview, getAnalyticsSummary, getSalesFunnel,
getRevenueBySource, getRepeatBuyerCohorts, getNetRevenue, getMrr.
Bundles
Sell several of your products as one bundle at one price (Growth plan and above — making a product a bundle answers403 FEATURE_LOCKED below it, details.feature: "bundles"; reading and removing never do). A bundle is a normal product whose productIds lists 2–10 of your other one-time products. Buying it is one order, one charge and one platform fee; every included product is delivered with its own access-grant order, and refunding the bundle revokes them all. Guide: Product bundles.
GET /bundles
GET /bundles
listBundlesResponsesGET /bundles/{id}
GET /bundles/{id}
productIds and items.Operation ID: getBundleParametersPUT /bundles/{id}
PUT /bundles/{id}
POST /products — its price is the bundle price), then call this. The product itself must have a fixed price.Operation ID: updateBundleRequest bodyContent type: application/jsonDELETE /bundles/{id}
DELETE /bundles/{id}
deleteBundleResponsesBuy more, save more
Store-wide tiered discounts such as “2 items 10% off, 3+ items 20% off” (free on every plan, Free included: turning them on never answers403 FEATURE_LOCKED). When one checkout holds several products (the main product plus order bumps or a downsell), the best tier reached is taken off the cart subtotal, server-side, after every per-item price is final. A bundle counts as one item. A tier never stacks with a discount code unless combineWithCodes is true. The order records it as tieredDiscount and order.completed carries it. Guide: Buy more, save more.
GET /tiered-discounts
GET /tiered-discounts
getTieredDiscountsPUT /tiered-discounts
PUT /tiered-discounts
updateTieredDiscountsRequest bodyDELETE /tiered-discounts
DELETE /tiered-discounts
deleteTieredDiscountsCheckout
Create hosted checkout links for your products and offersPOST /checkout/sessions
POST /checkout/sessions
productId. Redirect the buyer to the returned url. The link lives on your store subdomain, so your account needs a subdomain first (400 otherwise), and a one-time product must be published (409 for a draft). Payment methods (card, Apple Pay, Google Pay, Link, ACH, and country-specific methods such as iDEAL) are taken from the seller’s account — there is no payment-method parameter on this endpoint.Operation ID: createCheckoutSessionRequest bodyContent type: application/json
Required fields: productId.GET /checkout/abandoned/summary
GET /checkout/abandoned/summary
PATCH /products/{id}/abandoned-checkout) needs Growth.Operation ID: getAbandonedCheckoutSummaryResponsesCheckout offers
Payment plans (“Pay in 3”), exit offers and downsells on a product’s checkout (Growth plan and above — turning one on answers403 FEATURE_LOCKED below it, details.requiredPlan: "tier2"; turning it off never does). Guides: Payment plans, Exit offers and Checkout offers API.
GET /products/{id}/checkout-offers
GET /products/{id}/checkout-offers
getProductCheckoutOffersParametersPATCH /products/{id}/payment-plan
PATCH /products/{id}/payment-plan
installment: { index, of }, and the installment.paid / installment.failed webhooks fire. Needs a fixed price (not pay what you want). Partial update: fields you leave out keep their value. Turning it on needs the Growth plan.Operation ID: updateProductPaymentPlanParametersapplication/jsonPATCH /products/{id}/exit-offer
PATCH /products/{id}/exit-offer
exitOffer, downsell or both; fields left out keep their value. Turning either on needs the Growth plan.Operation ID: updateProductExitOfferParametersapplication/jsonGET /checkout-offers/{productId}
GET /checkout-offers/{productId}
null when it is off, or when the seller’s plan no longer includes it. Use it to build your own checkout page.Operation ID: getCheckoutOffersParametersCredits
Prepaid balances oncredits products: one balance per buyer per product. Record usage, and charge the buyer’s saved card for a top-up of any amount with no checkout page. Guide: Credit balances.
GET /credits/accounts
GET /credits/accounts
productId, status (active or paused). Each balance has balanceCents, currency, status, autoRefillOptIn (the buyer agreed to charges on their saved card), hasSavedCard and lastRefillAt. The saved card itself is never returned.Operation ID: listCreditAccountsGET /credits/accounts/{id}
GET /credits/accounts/{id}
getCreditAccountPOST /credits/deduct
POST /credits/deduct
accountId, amountCents (integer cents), optional reason. When this brings the balance to zero and the buyer opted in to auto-refill, one top-off charge runs on their saved card and its outcome comes back as refill. 409 with code: paused when a failed top-off paused the balance, code: insufficient when there is not enough balance.Operation ID: deductCreditsPOST /credits/accounts/{id}/charge
POST /credits/accounts/{id}/charge
- Body:
amountCents(integer cents, 50 to 1,000,000), optionalreason. - An idempotency key is required, in the
Idempotency-Keyheader or asidempotencyKey(8-100 letters, digits,-_:.). A retry with the same key returns the original charge and never charges twice. - The buyer must have agreed to charges on their saved card (they opted in to auto-refill at checkout). Otherwise
409withcode: no_consent.
chargeCreditTopUpCustomers
Access your customer baseGET /customers
GET /customers
numberOfOrders and a products array of { _id, name } for every product or subscription they bought). Optionally filter by product (matches any of the buyer’s purchases) and sort. The full list is returned — this endpoint is not paginated.Operation ID: listCustomersParametersGET /customers/{id}
GET /customers/{id}
getCustomerParametersCustomer CRM
Customer profiles (Pro plan and above): lifetime value net of refunds, orders, products, subscriptions, email engagement, segments, private notes and tags. Lifetime value is kept up to date on every sale and refund. Money fields end inCents and are integer cents of your account currency (currency). Guide: Customer CRM.
GET /customers/profiles
GET /customers/profiles
nextCursor as after.Operation ID: listCustomerProfilesParametersGET /customers/{id}/profile
GET /customers/{id}/profile
customer, ltv, products, subscriptions, email (received / opened / clicked, open rate, last opened), segments, contactTags, tags, notes and a timeline of up to 100 events (orders, subscription payments, refunds, subscriptions started / canceled, notes).Operation ID: getCustomerProfileParametersGET /customers/{id}/notes
GET /customers/{id}/notes
listCustomerNotesParametersPOST /customers/{id}/notes
POST /customers/{id}/notes
body, up to 2,000 characters; 200 notes per buyer). The author is recorded: owner, team member or api. Buyers never see notes.Operation ID: addCustomerNoteParametersDELETE /customers/{id}/notes/{noteId}
DELETE /customers/{id}/notes/{noteId}
deleteCustomerNoteParametersBenchmarks
Your last-90-day conversion rate, average order value, refund rate and email open rate next to anonymised stores of a similar size (Pro plan and above). Recomputed nightly; only the 25th percentile, median and 75th percentile of cohorts of 10 or more stores are ever returned. Guide: Benchmarks.GET /benchmarks
GET /benchmarks
status is ready, not_enough_stores (fewer than 10 similar stores yet) or no_data (no live sales in the last 90 days). cohort says which stores you are compared with; each of the four metrics has you, p25, median, p75, a verdict (top, above, below, bottom) and, below the median, one suggestion (id, feature, href, text). money values are cents of currency; percent values have one decimal.Operation ID: getBenchmarksResponsesDiscounts
Create and manage discount codesGET /discounts
GET /discounts
used (number of sales that used it)Operation ID: listDiscountsResponsesPOST /discounts
POST /discounts
400 if the code exists). mainProductIds must all be your own products or subscription offers in the key’s mode. Set expiration to end a promotion automatically, or active: false to stop it now.Operation ID: createDiscountRequest bodyContent type: application/json
Required fields: name, code, value, mainProductIds.GET /discounts/{id}
GET /discounts/{id}
getDiscountParametersPOST /discounts/{id}
POST /discounts/{id}
expiration: null to remove an expiry date. A new code must not clash with another of your discounts.Operation ID: updateDiscountParametersapplication/json
No required fields.DELETE /discounts/{id}
DELETE /discounts/{id}
deleteDiscountParametersGET /discounts/apply/{discountCode}/{productId}
GET /discounts/apply/{discountCode}/{productId}
applyDiscountCodeParametersGET /discounts/check-product/{productId}
GET /discounts/check-product/{productId}
true if any discount applies to the given product, false otherwise.Operation ID: checkProductDiscountsParametersGrowth checkout
Two Growth-plan features on a product’s checkout: the one-click offer shown right after a buyer pays, and aggregate social proof (“14 people bought this today”). Turning either on needs the Growth plan (403 FEATURE_LOCKED below it, details.requiredPlan: "tier2"); turning it off and reading the settings are never gated. Guides: Post-purchase offers, Checkout social proof and Growth checkout API. The buyer-side post-purchase routes are not part of the creator API.
GET /post-purchase/products/{id}
GET /post-purchase/products/{id}
discountPercent off. Accepting charges the card they just used in one click; the result is a normal order with its own order.completed and an order.post_purchase_accepted webhook.Operation ID: getPostPurchaseOfferParametersPUT /post-purchase/products/{id}
PUT /post-purchase/products/{id}
updatePostPurchaseOfferParametersapplication/jsonImages
Upload imagesPOST /images
POST /images
image; other field names return 400. PNG, JPEG, GIF, WebP and AVIF are accepted — the type is detected from the file’s bytes, not its name or declared type.Operation ID: uploadImageRequest bodyContent type: multipart/form-data
Required fields: image.Licenses
License keys for software you sell. The three PUBLIC endpoints are called from your app with the product id and the key — no API key, 60 requests per minute per IP. The rest manage your keys with your API key. Full guide, error codes and examples: License keys.validateLicenseKey, activateLicenseKey,
deactivateLicenseKey, listLicenseKeys, getLicenseKey,
disableLicenseKey, enableLicenseKey, resetLicenseKeyActivations.
Tracked links
Short links for every post, bio and ad, each with the visits and sales it brought in (Starter plan and above — below it, existing links keep working, creating or editing answers403 FEATURE_LOCKED and stats come back as
null with statsLocked: true). Full guide: Tracked links.
listTrackedLinks, createTrackedLink, getTrackedLinkStats,
updateTrackedLink, checkTrackedLinkSlug.
Launch pricing
Flash sales, fair pricing by country and early-bird price steps (Growth plan and above — turning a feature on answers403 FEATURE_LOCKED below it;
turning it off, deleting and reading never do). One rule prices every order:
the early-bird step in effect, then at most one discount, the best for the
buyer. Full guide: Launch pricing.
listFlashSales, createFlashSale, getFlashSale,
updateFlashSale, deleteFlashSale, createFlashSaleAnnouncement,
getFairPricing, updateFairPricing, getFairPricingAnalytics,
listPriceSteps, getProductLaunchPricing, setProductPriceSteps,
setProductFairPricing, getPriceQuote.
Courses
Drip content, quizzes and certificates for course products (Growth plan and above). Lessons are keyed by theirlessonId, which stays the same across
product edits. Reading settings and stats and deleting a quiz work on any
plan; changing drip rules, quizzes or the certificate answers
403 FEATURE_LOCKED below Growth. Full guide:
Drip content, quizzes and certificates.
getCourseSettings, updateCourseSettings, listCourseQuizzes,
upsertCourseQuiz, deleteCourseQuiz, getCourseStats, verifyCertificate.
PUT /courses/{id}
PUT /courses/{id}
lessons[] entry changes only what it names. drip is
{ "type": "immediate" }, { "type": "afterDays", "days": 7 } (1–3650) or
{ "type": "onDate", "date": "2026-11-02T09:00:00Z" }. quiz: null removes
a lesson’s quiz.GET /certificates/{verifyId}
GET /certificates/{verifyId}
7k2q-x9md-4htr works).404 when no certificate has the id.Creator services
Dispute help (every plan, answered first on Pro and above), priority support (Pro and above), a dedicated account manager (Volume and above) and dispute fees covered (Volume and above). Reads are never gated; gated writes below the plan answer403 FEATURE_LOCKED. Guides:
Priority support,
Account manager,
Dispute fees covered.
getCreatorServices, getAccountManager, requestSlackChannel,
listDisputeHelpRequests, createDisputeHelpRequest, listDisputeCovers,
getDisputeCover.
POST /creator-services/dispute-help
POST /creator-services/dispute-help
201 { request }, 400 invalid body, 403 FEATURE_LOCKED
(below Pro), 404 not your order, 409 ALREADY_REQUESTED.GET /creator-services/dispute-covers/{saleId}
GET /creator-services/dispute-covers/{saleId}
{ cover } with status (covered | excluded), excludedReason
(before_entitlement, monthly_limit, fraud_label, account_closed),
feeCents (1500), month, credit (mode: ledger | transfer,
status: recorded | credited | failed) and response.status
(todo, in_progress, submitted, won, lost).Google Sheets sync
New sales and new customers appended to a Google Sheet (Pro and above). Guide: Google Sheets sync.GET and DELETE are
never gated; the rest answer 403 FEATURE_LOCKED below Pro. When the server
has no Google connection configured, GET /sheets-sync answers
configured: false and the writes answer 503 SHEETS_NOT_CONFIGURED.
getSheetsSync, connectSheetsSync, setSheetsSpreadsheet,
updateSheetsSync, backfillSheetsSync, syncSheetsNow, retrySheetsSync,
disconnectSheetsSync. State errors answer 409 with code
SHEETS_NOT_CONNECTED, SHEETS_RECONNECT or SHEETS_NO_SPREADSHEET.
Link in Bio
Manage your Link in Bio page (creator page): profile, links, theme and which products it showsGET /creator-pages
GET /creator-pages
getCreatorPageResponsesPOST /creator-pages
POST /creator-pages
400 — update it with PUT /creator-pages. username is required and also becomes your store subdomain. Send JSON, or multipart/form-data to upload profilePicture, coverImage and images files.Operation ID: createCreatorPageRequest bodyContent type: application/json
Required fields: username.PUT /creator-pages
PUT /creator-pages
username also moves your store subdomain. JSON or multipart/form-data (file fields profilePicture, coverImage, images).Operation ID: updateCreatorPageRequest bodyContent type: application/json
No required fields.DELETE /creator-pages
DELETE /creator-pages
deleteCreatorPageResponsesPATCH /creator-pages/username
PATCH /creator-pages/username
https://{username}.pocketsflow.com).Operation ID: updateCreatorPageUsernameRequest bodyContent type: application/json
Required fields: username.GET /creator-pages/check-username/{username}
GET /creator-pages/check-username/{username}
checkCreatorPageUsernameParametersLoyalty
Loyalty points and store credit (Growth plan and above). Buyers earnearnPointsPerUnit points per 1.00 paid (your currency, before tax, after
discounts and credit) and spend them as credit at checkout
(pointsPerCreditUnit points = 1.00), applied by the server after every
discount and never below the 1.00 minimum charge. Turning it on, changing
rates and adjusting a balance below Growth answer 403 FEATURE_LOCKED;
{ "enabled": false } and reads never do. Full guide:
Loyalty points and store credit.
getLoyaltySettings, updateLoyaltySettings,
getLoyaltySummary, listLoyaltyMembers, listLoyaltyLedger,
adjustLoyaltyPoints.
loyaltyCredit, loyaltyPointsRedeemed and
loyaltyPointsEarned. Event: loyalty.credit_redeemed.
Orders
View your one-time product orders: the same data as the dashboard’s Orders pageGET /orders
GET /orders
status (paid, refunded, disputed, failed) and search by buyer email with search; when either is set, declined payments (status: failed, which never became a sale) are listed too. Every order carries its status. Subscription (recurring) transactions are NOT included here — list every payment (one-time and recurring) with GET /payments, and subscribers with GET /subscriptions/subscribers.Operation ID: listOrdersParametersGET /orders/{id}
GET /orders/{id}
_id of an order from GET /orders, or of a payment from GET /payments) — NOT a product id. For a subscription membership and its full payment history, use GET /orders/subscriptions/{id} with the subscriber id.Operation ID: getOrderParametersGET /orders/{id}/payment-details
GET /orders/{id}/payment-details
failureMessage, paymentsFailed). available: false when the processor no longer has the payment.Operation ID: getOrderPaymentDetailsParametersGET /orders/{id}/journey
GET /orders/{id}/journey
getOrderJourneyParametersGET /orders/{id}/downloads
GET /orders/{id}/downloads
limited is false when download limits don’t apply to this order). Full guide: Delivery & scarcity API.Operation ID: getOrderDownloadsParametersPOST /orders/{id}/downloads/reset
POST /orders/{id}/downloads/reset
resetOrderDownloadsParametersPaid newsletter
Lock posts behind a monthly or yearly subscription: paid members get the whole post, free subscribers a preview (Growth plan and above — turning it on and sending a paid / free-only post answer403 FEATURE_LOCKED below it).
Full guide: Paid newsletter.
getPaidNewsletter, updatePaidNewsletter, getNewsletterStats, syncPaidSubscribers, setPostAudience.
Partners
Become a Pocketsflow partner, refer users, and earn commissionsGET /partners
GET /partners
getPartnerResponsesPOST /partners
POST /partners
createPartnerResponsesPOST /partners/register-referral
POST /partners/register-referral
registerReferralRequest bodyContent type: application/json
Required fields: referralCode.GET /partners/referrals
GET /partners/referrals
listReferralsParametersGET /partners/referrals/sales
GET /partners/referrals/sales
listReferralSalesParametersGET /partners/stats
GET /partners/stats
getPartnerStatsResponsesPayments
Query the unified payment ledger — one-time purchases and subscription renewals — sourced from the payment processorGET /payments
GET /payments
type to narrow to one_time or subscription. Every payment is a Sale. Scoped to the key’s test/live mode.Operation ID: listPaymentsParametersGET /payments/{id}
GET /payments/{id}
Sale). Resolves the related product OR subscription offer (subscription payments carry an empty productId), the customer, and a paymentsPartner block sourced from the stored payments partner payload. Pass ?live=true to additionally fetch the authoritative live payment from the payments partner as paymentsPartnerLive (degrades gracefully on any error — never fails the request).Operation ID: getPaymentParametersPayouts
Read your payouts: whether payouts are active (and what, if anything, is needed from you), the balance waiting to be withdrawn, and every payout (withdrawal) with its status. Read only: withdrawing money happens in the dashboard.GET /payouts/status
GET /payouts/status
getPayoutStatusholdDays (days a sale stays pending), nextEligibleAt (when
the next pending money becomes withdrawable) and minimumWithdrawal
({ amount, currency } in the payout currency) are null when we don’t
publish that number; the Payouts page shows the live values. schedule.kind
is on_demand (withdraw whenever you like) or on_request (ask, and the team
sends it). Accounts with sales at our second payments partner also get a
platformBalance object with the same fields for that balance.ResponsesGET /payouts/balances
GET /payouts/balances
available) and what is still clearing (pending). pots lists each currency held. Read only. 404 when payouts are not connected yet.Operation ID: getPayoutBalanceResponsesGET /payouts
GET /payouts
requested → awaiting_payment → in_transit → completed; it can also end failed (e.g. the bank rejected it), canceled or denied (refused by compliance review: check GET /payouts/status).Operation ID: listPayoutsParametersGET /payouts/{id}
GET /payouts/{id}
404.Operation ID: getPayoutParameterspayout.created and payout.updated (webhook events).
Penny
Pocketsflow Penny 1, the decision model: one typed question (choice,
yes_no or score) about a situation, answered with a calibrated
confidence and auto (safe to act without a person). 1,000 free decisions
a month, then prepaid credits; 402 penny_credits_exhausted carries a
buy_url. Full guide: Penny decision API.
pennyDecide, getPennyUsage.
Plans
What your plan unlocks and the public plans catalogue. A write that turns on a feature your plan does not include answers403 FEATURE_LOCKED (see FeatureLocked); the creator upgrades at app.pocketsflow.com/profile/billing. Plans are bought in the dashboard only. See Plans and limits.
GET /users/entitlements
GET /users/entitlements
allowed: false answers 403 FEATURE_LOCKED. Plans are bought in the dashboard, never through the API.Operation ID: getEntitlementsResponsesGET /users/billing-tiers
GET /users/billing-tiers
listPlansResponsesPosts
Create, schedule and send newsletter email campaigns, or send one-off emailsGET / PUT /newsletters/paid,
GET /newsletters/paid/stats, POST /newsletters/paid/sync and
POST /newsletters/posts/{id}/audience. Posts also accept audience
(everyone / free / paid), sendPreviewToFree and publishToWeb. See
Paid newsletter API.
Products
Create and manage your one-time digital products. Subscription (recurring) offers are a separate resource — see Subscriptions.GET /products
GET /products
GET /subscriptions.Operation ID: listProductsResponsesPOST /products
POST /products
multipart/form-data to upload file, thumbnail and images. Pay-what-you-want products (payWant: true) must also send hasProductPage: "yes". Fires the product.created webhook.Operation ID: createProductRequest bodyContent type: application/json
Required fields: name.GET /products/{id}
GET /products/{id}
GET /subscriptions/{id} instead.Operation ID: getProductParametersDELETE /products/{id}
DELETE /products/{id}
product.deleted webhook. To delete a subscription (recurring) offer, use DELETE /subscriptions/{id}.Operation ID: deleteProductParametersPOST /products/update/{id}
POST /products/update/{id}
multipart/form-data). If the request sets payWant: true it must also send hasProductPage: "yes". Fires the product.updated webhook. Subscription (recurring) offers cannot be updated with an API key.Operation ID: updateProductParametersapplication/json
No required fields.POST /products/copy/{id}
POST /products/copy/{id}
{ "testMode": false } to copy a test-mode offer into live mode (“Copy to live”); omit the body to copy within the same mode. The copy gets a deduplicated “Name (Copy)” name and starts unpublished when copied into live mode.Operation ID: copyProductParametersapplication/json (body optional)
No required fields.PATCH /products/{id}/abandoned-checkout
PATCH /products/{id}/abandoned-checkout
GET /checkout/abandoned/summary shows what recovery would chase.Operation ID: setProductAbandonedCheckoutParametersapplication/json
Required fields: enabled.GET /products/{id}/limited-drop
GET /products/{id}/limited-drop
getLimitedDropParametersPATCH /products/{id}/limited-drop
PATCH /products/{id}/limited-drop
409 SOLD_OUT and the product page shows Sold out. A buyer who opens the checkout holds a copy for 15 minutes. Fields you leave out keep their value; raising the quantity reopens sales. The counts are never written directly. Turning the drop on needs the Starter plan or higher; turning it off is always allowed.Operation ID: updateLimitedDropParametersapplication/jsonGET /products/{id}/drop
GET /products/{id}/drop
{ enabled, quantity, remaining, sold, reserved, soldOut }. Everything is null and enabled is false when the drop is off or the creator’s plan no longer includes it.Operation ID: getLimitedDropAvailabilityParametersGET /products/{id}/pdf-stamping
GET /products/{id}/pdf-stamping
getPdfStampingParametersPATCH /products/{id}/pdf-stamping
PATCH /products/{id}/pdf-stamping
updatePdfStampingParametersapplication/json
Required fields: enabled.GET /products/{id}/download-limits
GET /products/{id}/download-limits
getDownloadLimitsParametersPATCH /products/{id}/download-limits
PATCH /products/{id}/download-limits
null clears a limit. Never retroactive: only orders placed after the limits were turned on are limited, unless applyToExisting is true. Turning them on needs the Growth plan or higher; turning them off is always allowed.Operation ID: updateDownloadLimitsParametersapplication/jsonPromotions
Unique coupons (every plan): one-time codes, one per recipient, that expire. Personal deadlines (Pro): a countdown and offer that start per person; their writes below Pro answer403 FEATURE_LOCKED. Full guide: Promotions.
listUniqueCodes, createUniqueCodes, exportUniqueCodes, listPersonalDeadlines, createPersonalDeadline, getPersonalOffer, getPersonalDeadline, updatePersonalDeadline, deletePersonalDeadline, listPersonalDeadlineEntries, startPersonalDeadline, getPersonalDeadlineLink.
Recommendations
Newsletter recommendations (free on every plan): suggest up to 3 creators on your subscribe success message; subscribers confirm by email before joining their list. Full guide: Newsletter recommendations.getRecommendations, updateRecommendations,
searchRecommendableCreators.
PUT /recommendations
PUT /recommendations
Referrals
Refer other creators (free on every plan). When a creator you invite sells $1,000 in any 30 days and those sales clear the 14-day refund window, you both sell your next $5,000 fee-free, at most 12 a year (shared with the badge). Referrals made before November 3, 2026 keep one free month of your plan. Full guide: Refer a creator.getReferralStats, listReferredStores.
status is one of signed_up, clearing, earned, not_eligible,
capped, expired. progressUsd is what a store still unlocking sold in the
last 30 days (it unlocks at 1,000); program is fee_free or, for referrals
made before November 3, 2026, free_month.
Refunds
Refund POLICIES — the refund terms shown to buyers at checkout, referenced by products viarefundPolicy. These endpoints do not refund payments: refunding a payment is done from the dashboard and has no API-key endpoint. Refunds that happen arrive as the order.refunded webhook and isRefunded on payments.
GET /refunds
GET /refunds
appliedTo — how many products use itOperation ID: listRefundPoliciesResponsesPOST /refunds
POST /refunds
refundPolicy). This does NOT refund a payment — refunds are issued from the dashboard.Operation ID: createRefundPolicyRequest bodyContent type: application/json
No required fields.GET /refunds/{id}
GET /refunds/{id}
getRefundPolicyParametersPOST /refunds/{id}
POST /refunds/{id}
updateRefundPolicyParametersapplication/json
No required fields.DELETE /refunds/{id}
DELETE /refunds/{id}
deleteRefundPolicyParametersReviews
Read your product reviewsGET /reviews
GET /reviews
listReviewsResponsesSales funnels
A free lead magnet → an email sequence → a paid offer, set up from one template (Growth plan and above — creating and activating answer403
FEATURE_LOCKED below it). Full guide: Sales funnels.
listFunnelTemplates, listFunnels, createFunnel,
getFunnel, renameFunnel, deleteFunnel, activateFunnel,
pauseFunnel, getFunnelStats.
Signup forms
Inline forms, slide-ins and exit popups for any website, feeding your audience (Growth plan and above — creating and editing answer403
FEATURE_LOCKED below it; pausing, archiving and deleting always work).
Full guide: Signup forms.
POST /forms/public/{id}/subscribe
POST /forms/public/{id}/subscribe
subscribeWithSignupFormRequest bodylistSignupForms, createSignupForm, getSignupForm,
updateSignupForm, deleteSignupForm, getPublicSignupForm,
subscribeWithSignupForm.
Resends and subject tests
Resend a sent post to the people who did not open it, or send a draft with an A/B subject test (Growth plan and above — scheduling and starting answer403 FEATURE_LOCKED below it). Every email counts toward your monthly
sends. Full guide: Resends and subject tests.
getPostResend, scheduleResendToNonOpeners,
cancelResendToNonOpeners, getSubjectTest, startSubjectTest.
Memberships
Members-only posts, a community and included products for your subscribers (Pro plan and above). A membership is tied to one or more subscription offers; anyone with a live subscription to one of them is a member, checked on every request. Creating or editing a membership and adding content answer403 FEATURE_LOCKED below Pro; reading, archiving, deleting and moderation
never do. Full guide: Memberships.
listMemberships, createMembership, getMembership,
updateMembership, deleteMembership, listMembershipMembers, banMember,
unbanMember, listMemberPosts, createMemberPost, getMemberPost,
updateMemberPost, deleteMemberPost, listCommunityThreads,
createCommunityThread, getCommunityThread, moderateCommunityThread,
deleteCommunityThread, replyToCommunityThread, moderateCommunityReply,
deleteCommunityReply.
POST /memberships
POST /memberships
member.joined fires for
each). Pro plan and above.Operation ID: createMembershipRequest bodyPOST /memberships/{id}/posts
POST /memberships/{id}/posts
html is sanitised on save (links
keep http, https and mailto; images https only; scripts, styles and iframes
are removed). Publishing with notify emails every live member once,
skipping anyone who opted out, unsubscribed from your emails or bounced.Operation ID: createMemberPostPOST /memberships/members/ban
POST /memberships/members/ban
hideContent: true also hides everything
they wrote. Never needs the plan.Operation ID: banMemberSegments
Saved audiences built from purchases, spend, engagement, tags and country (Growth plan and above;403 FEATURE_LOCKED below it). Full guide:
Segments.
listSegments, createSegment, previewSegment, getSegment, updateSegment, deleteSegment, getSegmentCount, listSegmentSubscribers.
Migrations
Import products, customers, purchase history and email subscribers from Gumroad, Lemon Squeezy, Stan Store or any CSV (every plan, including Free). Purchase history is saved as imported records, never as sales. Full guide: Migrations.listMigrationPlatforms, listMigrations, createMigration, getMigration, addMigrationFile, updateMigrationMapping, removeMigrationFile, listMigrationRows, connectMigrationAccount, dryRunMigration, startMigration, cancelMigration, getMigrationReport, downloadMigrationErrors.
POST /migrations
POST /migrations
source. Attach the CSV exports right away with files (one per kind, up to 10 MB / 50,000 rows each); columns are mapped from the platform’s export format. Nothing is written to your store until you start it.Operation ID: createMigrationRequest bodyPOST /migrations/{id}/connect
POST /migrations/{id}/connect
400 for other sources).Operation ID: connectMigrationAccountRequest bodyPOST /migrations/{id}/dry-run
POST /migrations/{id}/dry-run
dryRunMigrationResponsesPOST /migrations/{id}/start
POST /migrations/{id}/start
202. Poll GET /migrations/{id} for status and per-kind progress. Idempotent and resumable; starting a failed or canceled import imports the rest.Operation ID: startMigrationResponsesGET /migrations/{id}/report
GET /migrations/{id}/report
getMigrationReportRevenue splits
Sell one product with up to five co-creators and split every sale automatically (inviting needs the Growth plan and above —POST /revenue-splits and POST /revenue-splits/{id}/resend answer 403
FEATURE_LOCKED below it; everything a co-creator does is open on every
plan). The platform fee is taken once on the full pre-tax sale, then any
affiliate commission; each co-creator gets floor(base × share) in cents and
the owner keeps the rest. Money is in integer cents (…Cents). Full guide:
Revenue splits.
code: ALREADY_INVITED, TOO_MANY_COLLABORATORS,
SHARES_OVER_100, EMAIL_MISMATCH, PAYOUTS_REQUIRED, OWN_PRODUCT,
ACCOUNT_RESTRICTED, INVITE_EXPIRED, INVITE_CLOSED, NOT_LIVE,
NOT_PENDING.
Operation IDs: listRevenueSplits, createRevenueSplit, getRevenueSplit,
removeRevenueSplit, resendRevenueSplitInvite, getProductRevenueSplit,
listRevenueSplitSales, getRevenueSplitSale, listRevenueSplitInvites,
acceptRevenueSplitInvite, declineRevenueSplitInvite,
getRevenueSplitEarnings.
Testimonials
Buyer testimonials with optional video: moderate them, change the request email and where they show (Growth plan and above — approving, featuring and switching anything on answer403 FEATURE_LOCKED below it). Full guide:
Testimonials.
listTestimonials, getTestimonial, moderateTestimonial,
getTestimonialSettings, updateTestimonialSettings, getTestimonialWall.
Attribution survey
“How did you hear about us?” on the thank-you page, and the answers and revenue per channel next to your tracked links (Growth plan and above — turning it on answers403 FEATURE_LOCKED below it). Full guide:
Attribution survey.
getAttributionSurvey, updateAttributionSurvey,
getAttributionReport.
Store badge
The “Powered by Pocketsflow” badge on your buyer pages and receipts, and what it earned you. See Pocketsflow badge.GET /powered-by/me
GET /powered-by/me
getStoreBadgeResponsesPUT /powered-by
PUT /powered-by
true) or hide (false) the badge on every buyer page and receipt. Showing it is always allowed. Hiding it needs the Starter plan or higher; if the plan later ends, the badge shows again automatically and your choice is kept. While the badge is hidden it carries no referral link, so it earns no free months.Operation ID: updateStoreBadgeRequest bodySubscribers
Manage your newsletter email contacts and product audiencesSubscriptions
Manage subscription offers (the recurring products you sell) and subscribers (buyers’ memberships). The hosted subscriber portal link is delivered asportalUrl on subscribers and in subscription webhooks — pass it to the buyer unchanged (its token is what allows cancel/resume).
POST /subscriptions/{id}/upgrade
POST /subscriptions/{id}/upgrade
{id} is the subscriber or its membership id) to another subscription offer now, charging their saved card with no checkout page.- They pay the new price minus credit for the unused part of what they paid for the current period. Preview it with
GET /subscriptions/{id}/upgrade-quote?subscriptionId=. - The new subscription renews at the new price every period from today. The old one ends at once, and its
metadatacarries over to the new one. - Body:
subscriptionId(the offer to move to). An idempotency key is required, in theIdempotency-Keyheader or asidempotencyKey. A retry with the same key returns the original upgrade and never charges twice. - Not for subscriptions priced per seat or by usage, or for a move that would charge less than 1.00 (a downgrade).
upgradeSubscription. The quote: quoteSubscriptionUpgrade.GET /orders/subscriptions/{id}
GET /orders/subscriptions/{id}
status, and payments — every subscription Sale for this membership (the initial charge plus every renewal). {id} is the subscriber _id; a malformed or unknown id answers 404.Operation ID: getSubscriberOrderHistoryParametersGET /subscriptions
GET /subscriptions
GET /subscriptions/subscribers.Operation ID: listSubscriptionOffersResponsesPOST /subscriptions
POST /subscriptions
createSubscriptionOfferRequest bodyContent type: application/json or multipart/form-data
Required fields: name, price, frequency.GET /subscriptions/subscribers
GET /subscriptions/subscribers
status, cancelAtPeriodEnd, the membership id (membershipId), the portalUrl to hand to the buyer, and the joined subscription offer. Scoped to the key’s test/live mode.Operation ID: listSubscribersParametersGET /subscriptions/subscribers/{id}
GET /subscriptions/subscribers/{id}
status, and its full payment history (payments = every subscription Sale — the initial charge plus every renewal). Pass ?live=true to additionally fetch the authoritative membership status from the payments partner as membership (degrades gracefully to the stored status on any payments partner error — never fails the request).Operation ID: getSubscriberParametersGET /subscriptions/{id}
GET /subscriptions/{id}
getSubscriptionOfferParametersDELETE /subscriptions/{id}
DELETE /subscriptions/{id}
POST /subscriptions/{id}/cancel with a subscriber id for that.Operation ID: deleteSubscriptionOfferParametersPOST /subscriptions/{id}/cancel
POST /subscriptions/{id}/cancel
cancelAtPeriodEnd becomes true. {id} is the subscriber _id or membership id (mem_…) — not a sub_… id.Operation ID: cancelSubscriptionParametersPOST /subscriptions/{id}/pause
POST /subscriptions/{id}/pause
/resume. If the payments partner refuses, nothing changes (502). {id} is the subscriber _id or membership id (mem_…).Operation ID: pauseSubscriptionParametersPOST /subscriptions/{id}/resume
POST /subscriptions/{id}/resume
{id} is the subscriber _id or membership id (mem_…).Operation ID: resumeSubscriptionParametersSubscription retention
Failed payment recovery, cancellation save offers and intro pricing (Pro). Reads are open on every plan; writes answer403 FEATURE_LOCKED below Pro.
Full guide: Subscription retention.
getRecoverySummary, listAtRiskSubscriptions, getRecoverySettings, updateRecoverySettings, getSaveOffersReport, getIntroPricingReport, listRetentionOffers, getRetentionOffer, updateRetentionOffer.
Team
Invite people to run your store with you (Growth plan and above). Owners can do everything, including payouts and billing; admins everything except money and ownership; members only the areas of their teams. Seats: Growth 5, Pro 15, Scale 50, Volume unlimited (the owner counts as one). With an API key you act as the store owner. Accepting an invite, switching stores and leaving a store are a person’s own actions and stay in the dashboard. Full guides: Team members and Team API.GET /team
GET /team
teamsAllowed says whether yours includes team members.Operation ID: getTeamResponsesGET /team/activity
GET /team/activity
before set to the previous page’s nextBefore.Operation ID: listTeamActivityParametersaction is one of invite.created, invite.resent, invite.canceled, invite.accepted, member.updated, member.removed, member.left, member.paused_by_plan, member.resumed_by_plan, team.created, team.updated, team.deleted, or request (a change a team member made in the store).POST /team/invites
POST /team/invites
inviteTeamMemberRequest bodyContent type: application/json
Required fields: email, role.POST /team/invites/{id}/resend
POST /team/invites/{id}/resend
resendTeamInviteParametersDELETE /team/invites/{id}
DELETE /team/invites/{id}
cancelTeamInviteParametersPATCH /team/members/{id}
PATCH /team/members/{id}
pausedReason: "seat_limit" means they were paused automatically after a plan change and come back when seats free up.Operation ID: updateTeamMemberParametersapplication/jsonDELETE /team/members/{id}
DELETE /team/members/{id}
removeTeamMemberParametersPOST /team/teams
POST /team/teams
products (products and store design), orders (orders, customers and refunds), emails (emails and automations), marketing (discounts, upsells and affiliates), analytics, developers (API keys and webhooks). Unknown values are dropped.Operation ID: createTeamRequest bodyContent type: application/json
Required fields: name.PATCH /team/teams/{id}
PATCH /team/teams/{id}
updateTeamParametersapplication/jsonDELETE /team/teams/{id}
DELETE /team/teams/{id}
deleteTeamParametersUpsells
Configure upsell offers shown at checkoutGET /upsells
GET /upsells
salesWithUpsells — your sales that carry an upsellOperation ID: listUpsellsResponsesPOST /upsells
POST /upsells
upsellProductId must be one of your products (404 otherwise) and mainProductIds a non-empty list of your own products in the key’s mode (400 otherwise). upsellPrice must be 0 or more. Upsells are a Growth plan feature (403 FEATURE_LOCKED below Growth).Operation ID: createUpsellRequest bodyContent type: application/json
Required fields: mainProductIds, upsellProductId, upsellPrice.GET /upsells/{id}
GET /upsells/{id}
getUpsellParametersPOST /upsells/{id}
POST /upsells/{id}
upsellProductId, upsellPrice and mainProductIds change only when sent (and are validated like on create); every other listed field is written as sent — omitted ones are cleared — so send every text, style and active field you want to keep. PUT /upsells/{id} is an alias of this endpoint.Operation ID: updateUpsellParametersapplication/json
No required fields.DELETE /upsells/{id}
DELETE /upsells/{id}
deleteUpsellParametersWebhooks
Register endpoints that receive real-time event notifications. Delivery format, headers, signature verification and every event payload are documented in Webhook events.GET /webhooks
GET /webhooks
listWebhooksResponsesPOST /webhooks
POST /webhooks
secret — store it (you can also read it with GET /webhooks/{id} or replace it with POST /webhooks/{id}/rotate-secret). New webhooks start active; use PATCH /webhooks/{id} to disable one.Operation ID: createWebhookRequest bodyContent type: application/json
Required fields: url, events.GET /webhooks/{id}
GET /webhooks/{id}
secretOperation ID: getWebhookParametersPATCH /webhooks/{id}
PATCH /webhooks/{id}
url, events, description, or active flag. Only the fields you send change; they are validated like on create. The response does not include the secret.Operation ID: updateWebhookParametersapplication/json
No required fields.DELETE /webhooks/{id}
DELETE /webhooks/{id}
deleteWebhookParametersPOST /webhooks/{id}/rotate-secret
POST /webhooks/{id}/rotate-secret
rotateWebhookSecretParametersPOST /webhooks/{id}/test
POST /webhooks/{id}/test
order.completed-style payload and test: true in the body — and return the delivery outcome. The attempt is recorded in the delivery log.Operation ID: testWebhookParametersGET /delivered-webhooks
GET /delivered-webhooks
listWebhookDeliveriesParametersGET /delivered-webhooks/{id}
GET /delivered-webhooks/{id}
getWebhookDeliveryParametersPOST /delivered-webhooks/{id}/redeliver
POST /delivered-webhooks/{id}/redeliver
redeliverWebhookParametersWeekly report
The weekly growth report, emailed every Sunday at 23:59 UTC: the week’s sales, visits and conversion, charts, plus one recommended next step. Read it any day, and turn the email on or off. Free on every plan. Guide: Weekly growth report.GET /users/weekly-report/preview
GET /users/weekly-report/preview
subject, html, text).Operation ID: getWeeklyReportResponsesGET /users/weekly-report/settings
GET /users/weekly-report/settings
timeZone is always UTC).Operation ID: getWeeklyReportSettingsResponsesPUT /users/weekly-report/settings
PUT /users/weekly-report/settings
updateWeeklyReportSettingsRequest bodyObjects
The main response objects. Fields marked as money are decimal amounts in major currency units (e.g.29.99), never cents, unless the field name ends in Cents.
Product
A one-time product in your catalogOrder
An order as listed byGET /orders: the one-time Sale plus its product, customer reference, fee breakdown and purchased upsells.
Includes every field of Payment and OrderFees, plus:
OrderFees
Seller-facing fee breakdown attached to orders. All decimal amounts in the sale currency.Payment
A single payment (aSale). Covers BOTH one-time product purchases (isSubscription: false) and subscription payments — the initial charge and every renewal (isSubscription: true). Money fields are decimal amounts in currency, not cents.
Customer
A buyer of yours. One record per buyer email and test/live mode.Subscriber
A subscriber — a buyer’s membership (SubscriptionCustomer) in one of your subscription offers.
SubscriptionOffer
A recurring subscription offer owned by the authenticated sellerDiscount
Upsell
A post-purchase / order-bump offer shown at checkout for themainProductIds
Review
RefundPolicy
A refund policy — the refund terms shown to buyers at checkout. Products reference it by id (refundPolicy). Not a refund of a payment.
CheckoutSession
Webhook
WebhookDelivery
One delivery attempt from the webhook delivery log (kept for 30 days)WebhookEvent
The JSON body of an outgoing webhook delivery (not an API response). The envelope fields sit at the top level next to the event’s own fields — see the Webhook events section for headers and signature verification.Post
A newsletter post (email campaign)EmailSubscriber
A newsletter contactCreatorPage
Your Link in Bio pageUser
The authenticated account. Only integrator-relevant fields are listed; other dashboard-internal fields may appear and can change without notice — don’t rely on them.Pagination
Error
Error body. Most endpoints setmessage; authentication errors set both error and message; some add a machine-readable code. Read message first and fall back to error.
FeatureLocked
The403 body when a write would turn on a feature the account’s plan does not include. Nothing was saved and retrying will not help: tell the creator to upgrade at app.pocketsflow.com/profile/billing, then retry.
SellingProfile
What the creator sells and where their buyers pay (PUT /users/selling-profile). Both are optional answers from onboarding: null means not answered yet.
Entitlements
What the account’s plan unlocks (GET /users/entitlements). The plan is the active plan: a canceled paid plan reads as free once its paid period ends.
FeatureEntitlement
Plan
One plan of the public catalogue (GET /users/billing-tiers).
AbandonedCheckoutSummary
Need a typed client?
Use the Pocketsflow Node.js SDK for typed server-side calls, or import/docs.json into your preferred OpenAPI generator.