Skip to main content
This catalog lists every operation in the public OpenAPI contract: 248 paths and 341 operations. Every endpoint requires an API key unless its description says PUBLIC. A few SDK helpers (for example users.update and variants) call routes that are not in the public contract yet; see the SDK reference.

Interactive API explorer

Try requests, inspect schemas, and copy generated examples in Scalar.
The machine-readable contract is available at /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) or Authorization: Bearer pk_test_... (test data). The key decides the mode, not the dashboard toggle.
  • JSON requests use Content-Type: application/json; file uploads use multipart/form-data.
  • IDs are MongoDB ObjectId strings (24 hex characters). Payments-partner IDs such as plan_..., pay_..., and mem_... keep their prefixes.
  • Money is a decimal amount in major currency units (29.99), not cents.
  • Errors are JSON: { "message": "..." }, with error (authentication errors) and sometimes a machine-readable code. See Errors.
  • Every authenticated endpoint can also answer 401 (invalid key), 429 (rate limited — 600 requests/minute per account) and 500.
  • A write that turns on a feature the account’s plan does not include answers 403 with code: "FEATURE_LOCKED" (see FeatureLocked and Plans and limits). Check GET /users/entitlements first.
  • GET /orders, GET /payments and GET /delivered-webhooks are paginated with page and pageSize (maximum 100); most other lists return everything in one response.
Keep API keys server-side. Never put a secret key in browser code, a mobile app, a public repository, or a URL.

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 answers 403 FEATURE_LOCKED; reading, stopping, declaring a winner and deleting never do). A paid sale is a conversion. Full guide: A/B tests. Operation IDs: 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 pixels
Retrieve the authenticated account: ids, store name, subdomain, currency, the key’s test/live mode, and whether it can sell. Use subdomain to build storefront and product URLs.Operation ID: getCurrentUserResponsesTry it in the interactive API explorer.
Record the creator’s answers to onboarding’s optional first question, the same ones 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/json
ResponsesTry it in the interactive API explorer.
Set or remove the ad-platform ids loaded on your storefront, product, checkout and order-confirmation pages. Send only the fields you change; an empty string or 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/jsonResponsesTry it in the interactive API explorer.

Agencies

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. Operation IDs: getAgency, createAgency, updateAgency, listAgencyClients, removeAgencyClient, listAgencyStatements, getAgencyStatement, getStoreAgency, previewAgency, inviteAgency, removeStoreAgency.
Give an agency admin access to your store with its agency code. The agency can manage everything except payouts, billing and ownership; it holds no team seat and your plan does not need team members. One agency at a time.Request bodyResponses
Every client store with its plan, sales and orders over the last 30 days (USD, cents), subscribers, your earnings from it (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. Operation IDs: getAffiliateTiers, updateAffiliateTiers, listAffiliateTierProgress, getAffiliateTierProgress, listAffiliateBonuses, getMyAffiliateTierProgress.
PUT /affiliate-program
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 gets 403 FEATURE_LOCKED. Full guide: Analytics API. Operation IDs: 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 answers 403 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.
Every product of yours that is a bundle (current live / test mode), newest first, with what each includes and the buyer’s saving.Operation ID: listBundlesResponses
What a product includes. A product that is not a bundle answers with empty productIds and items.Operation ID: getBundleParametersResponses
Sets the products this product delivers. Create the bundle product first (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/json
Responses
Removes the included products; the product sells on its own again. Buyers who already bought the bundle keep every product they got. Never gated.Operation ID: deleteBundleResponses

Buy 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 answers 403 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.
Operation ID: getTieredDiscounts
Every field is optional; omitted fields keep their saved value. Turning it on (or saving while on) needs the Growth plan.Operation ID: updateTieredDiscountsRequest bodyResponses
Turns tiers off and removes them. Never gated.Operation ID: deleteTieredDiscounts

Checkout

Create hosted checkout links for your products and offers
Create a hosted checkout link for a one-time product OR a subscription (recurring) offer — pass either kind of id as 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.ResponsesTry it in the interactive API explorer.
How many live checkouts you lost over the last 30 days and what they were worth: a buyer typed their name or email (or had a payment declined) more than an hour ago and never paid. Each buyer counts once per product, and not at all if they bought it on another try. Always counts live checkouts, whatever the key’s mode. Readable on every plan; recovering them by email (PATCH /products/{id}/abandoned-checkout) needs Growth.Operation ID: getAbandonedCheckoutSummaryResponses
Try it in the interactive API explorer.

Checkout offers

Payment plans (“Pay in 3”), exit offers and downsells on a product’s checkout (Growth plan and above — turning one on answers 403 FEATURE_LOCKED below it, details.requiredPlan: "tier2"; turning it off never does). Guides: Payment plans, Exit offers and Checkout offers API.
The payment plan, exit offer and downsell settings of one of your products, as saved.Operation ID: getProductCheckoutOffersParametersResponses
Try it in the interactive API explorer.
Let buyers split the price into 2–6 payments, 30 days apart (“3 payments of $99”). The buyer gets the product on the first payment; every payment is its own order with 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: updateProductPaymentPlanParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
The exit offer shows a one-time discount (once per buyer session) when a buyer is about to leave the checkout; turning it on creates a discount with its own code, kept in step with the amount. The downsell offers a cheaper product when a buyer removes an order bump. Send exitOffer, downsell or both; fields left out keep their value. Turning either on needs the Growth plan.Operation ID: updateProductExitOfferParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
PUBLIC — no API key. What a product’s checkout offers right now (payment plan, exit offer, downsell), with the seller’s plan applied. An offer is 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: getCheckoutOffersParametersResponses
Try it in the interactive API explorer.

Credits

Prepaid balances on credits 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.
Newest activity first, at most 200. Query: 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: listCreditAccounts
One balance by id.Operation ID: getCreditAccount
Body: 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: deductCredits
Charge the buyer’s saved card off-session and add the amount to their balance. Use it for top-ups of any amount, in your own app, with no checkout page.
  • Body: amountCents (integer cents, 50 to 1,000,000), optional reason.
  • An idempotency key is required, in the Idempotency-Key header or as idempotencyKey (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 409 with code: no_consent.
ResponsesOperation ID: chargeCreditTopUp

Customers

Access your customer base
Retrieve all your customers in the key’s mode (deduplicated by email, each with a computed 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: listCustomersParametersResponsesTry it in the interactive API explorer.
Retrieve a customer with their stats, one-time orders, subscriptions and reviewsOperation ID: getCustomerParametersResponsesTry it in the interactive API explorer.

Customer 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 in Cents and are integer cents of your account currency (currency). Guide: Customer CRM.
Your buyers sorted by lifetime value (default), number of orders or last purchase, highest first. Cursor-paginated: pass nextCursor as after.Operation ID: listCustomerProfilesParametersResponsesTry it in the interactive API explorer.
Every CRM tag used on your buyers, alphabetically.Operation ID: listCustomerTagsResponsesTry it in the interactive API explorer.
One buyer on one page: 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: getCustomerProfileParametersResponsesTry it in the interactive API explorer.
A buyer’s private notes, newest first.Operation ID: listCustomerNotesParametersResponsesTry it in the interactive API explorer.
Add a private note (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: addCustomerNoteParametersResponsesTry it in the interactive API explorer.
Delete a note. Team members can delete their own notes; owners and admins any note.Operation ID: deleteCustomerNoteParametersResponsesTry it in the interactive API explorer.
Replace the buyer’s CRM tags (tags, up to 20, each up to 40 characters; lower-cased and deduplicated). Send [] to clear them.Operation ID: setCustomerTagsParametersResponsesTry it in the interactive API explorer.

Benchmarks

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.
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: getBenchmarksResponsesTry it in the interactive API explorer.

Discounts

Create and manage discount codes
Retrieve all your discount codes in the key’s mode, each with used (number of sales that used it)Operation ID: listDiscountsResponsesTry it in the interactive API explorer.
Create a new discount code. Codes are unique per account and mode (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.ResponsesTry it in the interactive API explorer.
Retrieve one of your discountsOperation ID: getDiscountParametersResponsesTry it in the interactive API explorer.
Partially update a discount — only the fields you send change. Send expiration: null to remove an expiry date. A new code must not clash with another of your discounts.Operation ID: updateDiscountParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Delete a discount codeOperation ID: deleteDiscountParametersResponsesTry it in the interactive API explorer.
PUBLIC (no API key) — used by the checkout. Validates a discount code against a product and returns the discount if it exists, is active, has not expired, and applies to the product. Returns 404 otherwise.Operation ID: applyDiscountCodeParametersResponsesTry it in the interactive API explorer.
PUBLIC (no API key) — used by the checkout. Returns true if any discount applies to the given product, false otherwise.Operation ID: checkProductDiscountsParametersResponsesTry it in the interactive API explorer.

Growth 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.
The one-click offer shown right after a buyer pays for this product: a “One more thing” step offering another of your products at 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: getPostPurchaseOfferParametersResponses
Try it in the interactive API explorer.
Choose the product to offer right after a buyer pays for this one, and an optional discount. Fields you leave out keep their value. The offered product must be another fixed-price, one-time product of yours in the same mode (not pay-what-you-want, not a credit pack) and still at least 1.00 after the discount. Turning the offer on needs the Growth plan.Operation ID: updatePostPurchaseOfferParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
What this product’s checkout may show about real purchases. Every number shown is real: live, non-refunded orders and live reviews only.Operation ID: getSocialProofSettingsParametersResponses
Try it in the interactive API explorer.
Turn checkout social proof on or off and choose what it shows. Fields you leave out keep their value. Turning it on needs the Growth plan. Changes reach checkouts within about a minute.Operation ID: updateSocialProofSettingsParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
PUBLIC — no API key. The aggregate numbers a checkout shows for this product (cached about 60 seconds). Use it to show the same proof on your own page. Aggregates only: no name, email, order id or amount. When the creator has it off or their plan no longer includes it, enabled is false and every other field is null.Operation ID: getSocialProofParametersResponses
Try it in the interactive API explorer.

Images

Upload images
Upload an image file as multipart/form-data. The file field must be named 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.ResponsesTry it in the interactive API explorer.

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. Operation IDs: validateLicenseKey, activateLicenseKey, deactivateLicenseKey, listLicenseKeys, getLicenseKey, disableLicenseKey, enableLicenseKey, resetLicenseKeyActivations. 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 answers 403 FEATURE_LOCKED and stats come back as null with statsLocked: true). Full guide: Tracked links. Operation IDs: 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 answers 403 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. Operation IDs: 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 their lessonId, 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. Operation IDs: getCourseSettings, updateCourseSettings, listCourseQuizzes, upsertCourseQuiz, deleteCourseQuiz, getCourseStats, verifyCertificate.
Merge update: each 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.
Responses
Public. Case and dashes don’t matter (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 answer 403 FEATURE_LOCKED. Guides: Priority support, Account manager, Dispute fees covered. Operation IDs: getCreatorServices, getAccountManager, requestSlackChannel, listDisputeHelpRequests, createDisputeHelpRequest, listDisputeCovers, getDisputeCover.
Sends our team the order (amount, product, buyer, status) and your notes, and opens a support thread where we reply. Every plan can ask; on Pro and above the thread is marked priority and answered first. One open request per order.BodyResponses: 201 { request }, 400 invalid body, 403 FEATURE_LOCKED (below Pro), 404 not your order, 409 ALREADY_REQUESTED.
{ 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. Operation IDs: getSheetsSync, connectSheetsSync, setSheetsSpreadsheet, updateSheetsSync, backfillSheetsSync, syncSheetsNow, retrySheetsSync, disconnectSheetsSync. State errors answer 409 with code SHEETS_NOT_CONNECTED, SHEETS_RECONNECT or SHEETS_NO_SPREADSHEET. Manage your Link in Bio page (creator page): profile, links, theme and which products it shows
Retrieve your Link in Bio page configuration and contentOperation ID: getCreatorPageResponsesTry it in the interactive API explorer.
Create your Link in Bio page. Create-only: if you already have a page this returns 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.ResponsesTry it in the interactive API explorer.
Partially update your Link in Bio page — only the fields you send change. Changing 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.ResponsesTry it in the interactive API explorer.
Delete your Link in Bio page. Your account subdomain is kept.Operation ID: deleteCreatorPageResponsesTry it in the interactive API explorer.
Change only the page username. It also becomes your store subdomain (https://{username}.pocketsflow.com).Operation ID: updateCreatorPageUsernameRequest bodyContent type: application/json Required fields: username.ResponsesTry it in the interactive API explorer.
Check a Link in Bio username / store subdomain before claiming it. Your own current username counts as available.Operation ID: checkCreatorPageUsernameParametersResponsesTry it in the interactive API explorer.

Loyalty

Loyalty points and store credit (Growth plan and above). Buyers earn earnPointsPerUnit 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. Operation IDs: getLoyaltySettings, updateLoyaltySettings, getLoyaltySummary, listLoyaltyMembers, listLoyaltyLedger, adjustLoyaltyPoints.
PUT /loyalty
Orders carry loyaltyCredit, loyaltyPointsRedeemed and loyaltyPointsEarned. Event: loyalty.credit_redeemed.

Orders

View your one-time product orders: the same data as the dashboard’s Orders page
Retrieve your one-time product orders, newest first, paginated — the same list as the dashboard’s Orders page. Filter by 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: listOrdersParametersResponsesTry it in the interactive API explorer.
Retrieve one order by its sale id (the _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: getOrderParametersResponsesTry it in the interactive API explorer.
The payment behind an order, read live from the payment processor: status, amounts, tax, itemised fees, refunds, dispute alert, the card or payment method used, billing address, 3-D Secure and the processor’s risk score and signals. Works for declined payments too (failureMessage, paymentsFailed). available: false when the processor no longer has the payment.Operation ID: getOrderPaymentDetailsParametersResponsesTry it in the interactive API explorer.
The checkout session behind an order: when it opened, how many card attempts were declined, when it completed or failed, and the authorization rate.Operation ID: getOrderJourneyParametersResponsesTry it in the interactive API explorer.
What the buyer of this order downloaded, what they have left and when their links expire (limited is false when download limits don’t apply to this order). Full guide: Delivery & scarcity API.Operation ID: getOrderDownloadsParametersResponsesTry it in the interactive API explorer.
Give the buyer of this order all their downloads back; the link expiry starts again from now. Never gated by plan.Operation ID: resetOrderDownloadsParametersResponsesTry it in the interactive API explorer.
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 answer 403 FEATURE_LOCKED below it). Full guide: Paid newsletter. Operation IDs: getPaidNewsletter, updatePaidNewsletter, getNewsletterStats, syncPaidSubscribers, setPostAudience.

Partners

Become a Pocketsflow partner, refer users, and earn commissions
Retrieve your partner profile including referral code and denormalized stats.Operation ID: getPartnerResponsesTry it in the interactive API explorer.
Register as a Pocketsflow partner. You’ll receive a unique referral code to share. When users sign up using your code, you earn commissions on their sales.Operation ID: createPartnerResponsesTry it in the interactive API explorer.
Call this after a user signs up through a partner’s referral link. Sets the referral code on the authenticated user and increments the partner’s signup count. Only accounts created within the last 30 days can attach a referral code, and never their own.Operation ID: registerReferralRequest bodyContent type: application/json Required fields: referralCode.ResponsesTry it in the interactive API explorer.
List all users who signed up using your referral code. Each user includes their live sales count and total revenue in USD.Operation ID: listReferralsParametersResponsesTry it in the interactive API explorer.
Get the live sales of users who signed up through your referral code (test-mode and refunded sales excluded), newest first. Each item carries the seller, amounts, USD revenue and your commission — never buyer data.Operation ID: listReferralSalesParametersResponsesTry it in the interactive API explorer.
Get live-computed aggregated stats: total signups, total sales, total revenue, and total commission earned based on your commission rate.Operation ID: getPartnerStatsResponsesTry it in the interactive API explorer.

Payments

Query the unified payment ledger — one-time purchases and subscription renewals — sourced from the payment processor
Retrieve a paginated ledger of ALL payments — one-time product purchases AND subscription payments (the initial charge plus every renewal). Filter by type to narrow to one_time or subscription. Every payment is a Sale. Scoped to the key’s test/live mode.Operation ID: listPaymentsParametersResponsesTry it in the interactive API explorer.
Retrieve a single payment (a 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: getPaymentParametersResponsesTry it in the interactive API explorer.

Payouts

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.
Whether payouts are active for the account, and if not, why and what (if anything) is needed: identity verification, an information request, a review in progress or a hold. Read only and safe to call often. Scoped to the key’s test/live mode.Operation ID: getPayoutStatus
Payout timing: holdDays (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.Responses
The balance at the payments partner, quoted in the account currency: what is available to withdraw (available) and what is still clearing (pending). pots lists each currency held. Read only. 404 when payouts are not connected yet.Operation ID: getPayoutBalanceResponses
Your payouts (withdrawals), newest first, with their status, fees and net amount. Empty when payouts are not connected yet. A payout moves 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: listPayoutsParameters
Responses
One payout with its current status, read live from the payments partner. Another account’s payout id answers 404.Operation ID: getPayoutParametersResponses
Events: payout.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. Operation IDs: pennyDecide, getPennyUsage.

Plans

What your plan unlocks and the public plans catalogue. A write that turns on a feature your plan does not include answers 403 FEATURE_LOCKED (see FeatureLocked); the creator upgrades at app.pocketsflow.com/profile/billing. Plans are bought in the dashboard only. See Plans and limits.
The account’s active plan, billing interval, platform fee rate, team seats, and one entry per feature key saying whether it is available right now and which plan it needs. Call it before using a paid feature (custom domains, premium templates, ad pixels, upsells, abandoned checkout recovery, affiliates…): a write that turns on a feature with allowed: false answers 403 FEATURE_LOCKED. Plans are bought in the dashboard, never through the API.Operation ID: getEntitlementsResponses
Try it in the interactive API explorer.
PUBLIC — no API key needed. The plans catalogue: monthly and yearly price (yearly = two months free), platform fee rate (2%; 1% on Volume, 0.5% on Volume Max), newsletter caps, team seats and the feature keys each plan includes. Enterprise is contact-us and not listed.Operation ID: listPlansResponsesTry it in the interactive API explorer.

Posts

Create, schedule and send newsletter email campaigns, or send one-off emails Resends to non-openers and subject tests on a post are listed under Resends and subject tests. Paid newsletter (Growth plan): GET / 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.
Retrieve your newsletter posts, newest first, optionally only one status. Not paginated.Operation ID: listPostsParametersResponsesTry it in the interactive API explorer.
Create a newsletter post. Requires newsletter settings (sender) to be configured first. A post is a draft unless you send status: "scheduled" with scheduledAt (queued for that time) or status: "automation". Sender address, from name and reply-to default to your newsletter settings. Send it now with POST /newsletters/posts/{id}/send.Operation ID: createPostRequest bodyContent type: application/json Required fields: name.ResponsesTry it in the interactive API explorer.
Retrieve one of your newsletter posts (a malformed id answers 404)Operation ID: getPostParametersResponsesTry it in the interactive API explorer.
Partially update a post — only the fields you send change. Sent posts cannot be edited (400). Setting status: "scheduled" with scheduledAt (re)queues the post after the send-allowance check; moving a scheduled post to draft unschedules it.Operation ID: updatePostParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Delete a newsletter post (a scheduled post is unscheduled first). Returns the deleted post.Operation ID: deletePostParametersResponsesTry it in the interactive API explorer.
Queue the post for immediate delivery to its audience (sendToAll, subscriberIds, productIds, tags). The post moves to sending, then sent (or failed). Requires a verified sender email. Calling it again while the post is sending is a no-op (Post is already sending).Operation ID: sendPostParametersResponsesTry it in the interactive API explorer.
Send an email to up to 100 recipients programmatically. Requires a verified sender email (configure it in Newsletters → Settings). The email is sent with your standard footer, physical address, and unsubscribe link, and is recorded as a sent post (source: api). Recipients who unsubscribed from you are skipped (listed in skipped); the rest count against your monthly send allowance.Operation ID: sendEmailRequest bodyContent type: application/json Required fields: to, subject.ResponsesTry it in the interactive API explorer.

Products

Create and manage your one-time digital products. Subscription (recurring) offers are a separate resource — see Subscriptions.
Retrieve your one-time products in the key’s mode, newest first. Returns a bare array (not paginated). Subscription (recurring) offers are a separate resource — list them with GET /subscriptions.Operation ID: listProductsResponsesTry it in the interactive API explorer.
Create a new one-time product. Send JSON, or 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.ResponsesTry it in the interactive API explorer.
Retrieve one of your one-time products. A subscription (recurring) offer’s id 404s here with a hint — fetch it with GET /subscriptions/{id} instead.Operation ID: getProductParametersResponsesTry it in the interactive API explorer.
Delete one of your one-time products. Fires the product.deleted webhook. To delete a subscription (recurring) offer, use DELETE /subscriptions/{id}.Operation ID: deleteProductParametersResponsesTry it in the interactive API explorer.
Partially update one of your one-time products — send only the fields to change (JSON or 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: updateProductParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Duplicate one of your one-time products (or a subscription offer, whichever owns the id) as a NEW item. Send { "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: copyProductParametersRequest bodyContent type: application/json (body optional) No required fields.ResponsesTry it in the interactive API explorer.
Opt-in, off by default. When on, the checkout shows an email field (with a consent line) and a buyer who typed their email and left without paying gets one recovery email with a link back to the checkout. Turning it on needs the Growth plan or higher; turning it off is always allowed. Recovery also stops by itself while the account is below Growth, without touching this switch. GET /checkout/abandoned/summary shows what recovery would chase.Operation ID: setProductAbandonedCheckoutParametersRequest bodyContent type: application/json Required fields: enabled.ResponsesTry it in the interactive API explorer.
The product’s limited drop (“Only 100 copies”) and its live counts: copies sold, copies held by buyers on the checkout right now, and copies left. Full guide: Delivery & scarcity API.Operation ID: getLimitedDropParametersResponsesTry it in the interactive API explorer.
Sell a fixed number of copies. When every copy is sold the checkout refuses new buyers with 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: updateLimitedDropParametersRequest bodyContent type: application/jsonResponsesTry it in the interactive API explorer.
PUBLIC — no API key. The live counter a product page shows, cached a few seconds: { 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: getLimitedDropAvailabilityParametersResponsesTry it in the interactive API explorer.
Whether the PDFs buyers download from this product carry their email, order number and date.Operation ID: getPdfStampingParametersResponsesTry it in the interactive API explorer.
When on, every PDF of this product is stamped with the buyer’s email, order number and date in a small footer on each page as they download it. Other files are delivered untouched; a PDF that can’t be stamped is delivered as is. Turning it on needs the Starter plan or higher; turning it off is always allowed.Operation ID: updatePdfStampingParametersRequest bodyContent type: application/json Required fields: enabled.ResponsesTry it in the interactive API explorer.
How many times each file of this product can be downloaded per order, and for how many days after the purchase.Operation ID: getDownloadLimitsParametersResponsesTry it in the interactive API explorer.
Limit downloads per file per order and/or make the links expire some days after the purchase. Fields you leave out keep their value; 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: updateDownloadLimitsParametersRequest bodyContent type: application/jsonResponsesTry it in the interactive API explorer.

Promotions

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 answer 403 FEATURE_LOCKED. Full guide: Promotions. Operation IDs: 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. Operation IDs: getRecommendations, updateRecommendations, searchRecommendableCreators.
Request body (every field optional)Responses

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. Operation IDs: 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 via refundPolicy. 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.
Retrieve your refund POLICIES in the key’s mode, newest first, each with appliedTo — how many products use itOperation ID: listRefundPoliciesResponsesTry it in the interactive API explorer.
Create a refund POLICY (refund terms shown at checkout) that products reference by id (refundPolicy). This does NOT refund a payment — refunds are issued from the dashboard.Operation ID: createRefundPolicyRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
PUBLIC (no API key) — retrieve a refund POLICY by its id. Checkout renders it for buyers.Operation ID: getRefundPolicyParametersResponsesTry it in the interactive API explorer.
Update one of your refund POLICIES — only the fields you send change.Operation ID: updateRefundPolicyParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Delete one of your refund POLICIES. Returns the deleted policy. Products that referenced it keep the stale id — update them.Operation ID: deleteRefundPolicyParametersResponsesTry it in the interactive API explorer.

Reviews

Read your product reviews
Retrieve all reviews across your products in the key’s mode, newest first. Not paginated; filtering is not supported.Operation ID: listReviewsResponsesTry it in the interactive API explorer.

Sales funnels

A free lead magnet → an email sequence → a paid offer, set up from one template (Growth plan and above — creating and activating answer 403 FEATURE_LOCKED below it). Full guide: Sales funnels. Operation IDs: 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 answer 403 FEATURE_LOCKED below it; pausing, archiving and deleting always work). Full guide: Signup forms.
Public (no API key, any origin). Adds the email to the form owner’s audience with the form’s tags, or emails a confirmation link with double opt-in. 10 signups per 15 minutes per IP.Operation ID: subscribeWithSignupFormRequest bodyResponses
Operation IDs: listSignupForms, 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 answer 403 FEATURE_LOCKED below it). Every email counts toward your monthly sends. Full guide: Resends and subject tests. Operation IDs: 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 answer 403 FEATURE_LOCKED below Pro; reading, archiving, deleting and moderation never do. Full guide: Memberships. Operation IDs: listMemberships, createMembership, getMembership, updateMembership, deleteMembership, listMembershipMembers, banMember, unbanMember, listMemberPosts, createMemberPost, getMemberPost, updateMemberPost, deleteMemberPost, listCommunityThreads, createCommunityThread, getCommunityThread, moderateCommunityThread, deleteCommunityThread, replyToCommunityThread, moderateCommunityReply, deleteCommunityReply.
Create a membership from one or more of your subscription offers. Everyone already subscribed becomes a member right away (member.joined fires for each). Pro plan and above.Operation ID: createMembershipRequest bodyResponses
Save a draft or publish straight away. 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: createMemberPost
Ban someone (by email) from every community of your store. While their subscription is live they keep your posts and included products, but can’t read or write in the community. hideContent: true also hides everything they wrote. Never needs the plan.Operation ID: banMember
Try it in the interactive API explorer.

Segments

Saved audiences built from purchases, spend, engagement, tags and country (Growth plan and above; 403 FEATURE_LOCKED below it). Full guide: Segments. Operation IDs: 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. Operation IDs: listMigrationPlatforms, listMigrations, createMigration, getMigration, addMigrationFile, updateMigrationMapping, removeMigrationFile, listMigrationRows, connectMigrationAccount, dryRunMigration, startMigration, cancelMigration, getMigrationReport, downloadMigrationErrors.
Creates a draft import from 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 bodyResponsesTry it in the interactive API explorer.
Pulls products, sales / orders, customers and (Lemon Squeezy) marketing opt-ins with a personal token the creator creates on the platform. The token is used for this one pull and is never stored or logged. Gumroad and Lemon Squeezy only (400 for other sources).Operation ID: connectMigrationAccountRequest bodyResponses
Counts what the run would create, skip (already in your store) and leave out (invalid rows, no email consent, addresses on the bounce / complaint list, over the subscriber limit). Writes nothing.Operation ID: dryRunMigrationResponses
Queues the background run and answers 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: startMigrationResponses
Per kind: imported, skipped, invalid, failed and pending rows; the products created, the files downloaded and the products that still need their file (with the reason).Operation ID: getMigrationReport

Revenue 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. Errors carry a 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 answer 403 FEATURE_LOCKED below it). Full guide: Testimonials. Operation IDs: 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 answers 403 FEATURE_LOCKED below it). Full guide: Attribution survey. Operation IDs: getAttributionSurvey, updateAttributionSurvey, getAttributionReport.

Store badge

The “Powered by Pocketsflow” badge on your buyer pages and receipts, and what it earned you. See Pocketsflow badge.
Whether the badge shows on your buyer pages, whether your plan lets you hide it, your badge referral code and link, and what the badge earned: link clicks, stores that signed up through it, stores whose first payment is clearing (14 days), and free months earned, applied and banked (at most 12 a year).Operation ID: getStoreBadgeResponses
Try it in the interactive API explorer.
Show (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 bodyResponsesTry it in the interactive API explorer.

Subscribers

Manage your newsletter email contacts and product audiences
Every product and subscription in the key’s mode, with how many people bought it (customers) and how many of them are active email contacts (subscribers). Biggest audiences first.Operation ID: listProductAudiencesResponsesTry it in the interactive API explorer.
Adds everyone who bought the product (or every buyer, when productId is omitted) to your subscribers and links them to what they bought. Contacts who unsubscribed stay unsubscribed.Operation ID: syncProductAudienceRequest bodyContent type: application/json (body optional) No required fields.ResponsesTry it in the interactive API explorer.
Retrieve all your newsletter contacts, newest first. Each carries productIds: the products and subscriptions they bought. Not paginated.Operation ID: listEmailSubscribersParametersResponsesTry it in the interactive API explorer.
Retrieve one of your newsletter contactsOperation ID: getEmailSubscriberParametersResponsesTry it in the interactive API explorer.
Delete a contact from your list. Returns the deleted contact.Operation ID: deleteEmailSubscriberParametersResponsesTry it in the interactive API explorer.

Subscriptions

Manage subscription offers (the recurring products you sell) and subscribers (buyers’ memberships). The hosted subscriber portal link is delivered as portalUrl on subscribers and in subscription webhooks — pass it to the buyer unchanged (its token is what allows cancel/resume).
Move a subscriber ({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 metadata carries over to the new one.
  • Body: subscriptionId (the offer to move to). An idempotency key is required, in the Idempotency-Key header or as idempotencyKey. 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).
ResponsesOperation ID: upgradeSubscription. The quote: quoteSubscriptionUpgrade.
Retrieve a single subscriber (SubscriptionCustomer) by id together with its subscription offer, customer, legacy card-subscription data (when applicable), the payments-partner-sourced live 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: getSubscriberOrderHistoryParametersResponsesTry it in the interactive API explorer.
Retrieve all of your subscription OFFERS (the recurring products you sell) in the key’s mode. To list your subscribers (buyers) instead, use GET /subscriptions/subscribers.Operation ID: listSubscriptionOffersResponsesTry it in the interactive API explorer.
Create a recurring subscription offer. Accepts JSON for API clients and multipart/form-data when uploading files or images. Pricing is charged in USD while multi-currency is disabled.Operation ID: createSubscriptionOfferRequest bodyContent type: application/json or multipart/form-data Required fields: name, price, frequency.ResponsesTry it in the interactive API explorer.
Retrieve a paginated list of your subscribers (buyers with a membership in one of your subscription offers). Each subscriber carries a payments-partner-sourced live 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: listSubscribersParametersResponsesTry it in the interactive API explorer.
Retrieve a single subscriber, its subscription offer, the customer record, the payments-partner-sourced live 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: getSubscriberParametersResponsesTry it in the interactive API explorer.
Retrieve one of your subscription OFFERS in the key’s mode.Operation ID: getSubscriptionOfferParametersResponsesTry it in the interactive API explorer.
Delete one of your subscription OFFERS in the key’s mode. This removes the offer from your catalog; it does not cancel existing subscribers — use POST /subscriptions/{id}/cancel with a subscriber id for that.Operation ID: deleteSubscriptionOfferParametersResponsesTry it in the interactive API explorer.
Schedules the subscriber’s membership to cancel at the end of the current billing period (same as the subscriber portal). Access continues until then; cancelAtPeriodEnd becomes true. {id} is the subscriber _id or membership id (mem_…) — not a sub_… id.Operation ID: cancelSubscriptionParametersResponsesTry it in the interactive API explorer.
Pauses payment collection on the subscriber’s membership. The buyer keeps access and is not charged until /resume. If the payments partner refuses, nothing changes (502). {id} is the subscriber _id or membership id (mem_…).Operation ID: pauseSubscriptionParametersResponsesTry it in the interactive API explorer.
Restarts payment collection on a paused membership, or otherwise reverses a pending cancel-at-period-end (same as the subscriber portal). {id} is the subscriber _id or membership id (mem_…).Operation ID: resumeSubscriptionParametersResponsesTry it in the interactive API explorer.

Subscription retention

Failed payment recovery, cancellation save offers and intro pricing (Pro). Reads are open on every plan; writes answer 403 FEATURE_LOCKED below Pro. Full guide: Subscription retention. Operation IDs: 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.
Members, pending invites, teams and seat usage. Seats are re-checked first: after a downgrade the newest members beyond the plan’s seats are paused (never removed). Readable on every plan; teamsAllowed says whether yours includes team members.Operation ID: getTeamResponses
Try it in the interactive API explorer.
Who did what in your store, newest first: team changes and every change a team member made. Kept for 400 days. Page with before set to the previous page’s nextBefore.Operation ID: listTeamActivityParametersResponsesaction 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).
Try it in the interactive API explorer.
Emails a one-time invite link (valid 7 days). The person accepts it signed in with this exact, verified email. Only owners invite owners. Up to 20 invites per hour. Team members are a Growth plan feature.Operation ID: inviteTeamMemberRequest bodyContent type: application/json Required fields: email, role.Responses
Try it in the interactive API explorer.
Sends a new link (the old one stops working) and restarts the 7 days. Once a minute, at most 5 times.Operation ID: resendTeamInviteParametersResponses
Try it in the interactive API explorer.
The link stops working and its seat is freed.Operation ID: cancelTeamInviteParametersResponsesTry it in the interactive API explorer.
Only owners make or change owners. A store always keeps at least one owner. Resuming a paused member needs a free seat. Takes effect on the member’s next request. Paused members keep their seat history but cannot open the store; pausedReason: "seat_limit" means they were paused automatically after a plan change and come back when seats free up.Operation ID: updateTeamMemberParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
Remove a member. They lose access on their next request.Operation ID: removeTeamMemberParametersResponsesTry it in the interactive API explorer.
A named group of members and the areas of the store they can use (up to 50 teams). Areas: 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.Responses
Try it in the interactive API explorer.
Applies to the team’s members on their next request.Operation ID: updateTeamParametersRequest bodyContent type: application/jsonResponses
Try it in the interactive API explorer.
Its members stay on the store but lose the team’s areas.Operation ID: deleteTeamParametersResponsesTry it in the interactive API explorer.

Upsells

Configure upsell offers shown at checkout
Retrieve your upsells in the key’s mode, plus salesWithUpsells — your sales that carry an upsellOperation ID: listUpsellsResponsesTry it in the interactive API explorer.
Create a new upsell offer. 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.ResponsesTry it in the interactive API explorer.
Retrieve one of your upsellsOperation ID: getUpsellParametersResponsesTry it in the interactive API explorer.
Update an existing upsell. 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: updateUpsellParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Delete an upsell offerOperation ID: deleteUpsellParametersResponsesTry it in the interactive API explorer.

Webhooks

Register endpoints that receive real-time event notifications. Delivery format, headers, signature verification and every event payload are documented in Webhook events.
Retrieve your webhook endpoints in the key’s mode, newest first. Secrets are omitted.Operation ID: listWebhooksResponsesTry it in the interactive API explorer.
Register an endpoint that receives the selected events. The endpoint is created in the key’s mode and only receives events from that mode. The response carries the signing 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.ResponsesTry it in the interactive API explorer.
Retrieve one of your webhook endpoints, including its signing secretOperation ID: getWebhookParametersResponsesTry it in the interactive API explorer.
Update an endpoint’s 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: updateWebhookParametersRequest bodyContent type: application/json No required fields.ResponsesTry it in the interactive API explorer.
Delete one of your webhook endpoints in the key’s mode.Operation ID: deleteWebhookParametersResponsesTry it in the interactive API explorer.
Replace the endpoint’s signing secret and return the new one. Deliveries are signed with the new secret immediately — update your verifier first.Operation ID: rotateWebhookSecretParametersResponsesTry it in the interactive API explorer.
Send a sample event to this endpoint only — its first subscribed event type, with a sample 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: testWebhookParametersResponsesTry it in the interactive API explorer.
The delivery log: every webhook delivery attempt in the key’s mode (including tests and redeliveries), newest first, paginated. Entries are kept for 30 days.Operation ID: listWebhookDeliveriesParametersResponsesTry it in the interactive API explorer.
Retrieve one delivery-log entry, including the exact body that was sent.Operation ID: getWebhookDeliveryParametersResponsesTry it in the interactive API explorer.
Send a logged delivery’s stored body to its endpoint again (same event id, freshly signed) and record the new attempt. Use it to replay events your endpoint missed.Operation ID: redeliverWebhookParametersResponsesTry it in the interactive API explorer.

Weekly 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.
The latest weekly growth report, the one emailed every Sunday at 23:59 UTC for the week Monday 00:00 to Sunday 23:59 UTC (before Sunday’s send it is the previous week): revenue and paid orders in your account currency with the change vs the week before, unique visitors, conversion rate, best-selling product, top traffic source, the daily revenue / visitor series and top products and sources behind the email’s charts, your email week (subscribers, campaigns, sends, open and click rates), and one recommended next step with a dashboard link. Figures are computed exactly like the dashboard’s analytics for the same Monday-to-Monday UTC range, live data only. Also returns the rendered email (subject, html, text).Operation ID: getWeeklyReportResponsesTry it in the interactive API explorer.
Whether the weekly growth report email is on (it is by default) and when the next one is due (every Sunday at 23:59 UTC; timeZone is always UTC).Operation ID: getWeeklyReportSettingsResponsesTry it in the interactive API explorer.
Turn the weekly growth report email (Sundays 23:59 UTC) on or off for your account. Takes effect immediately.Operation ID: updateWeeklyReportSettingsRequest bodyResponsesTry it in the interactive API explorer.

Objects

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 catalog

Order

An order as listed by GET /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 (a Sale). 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 seller

Discount

Upsell

A post-purchase / order-bump offer shown at checkout for the mainProductIds

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 contact

CreatorPage

Your Link in Bio page

User

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 set message; authentication errors set both error and message; some add a machine-readable code. Read message first and fall back to error.

FeatureLocked

The 403 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.