REST API endpoint reference - Pocketsflow Docs

This catalog lists every operation in the public OpenAPI contract: 61 paths and 85 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.
GET /orders, GET /payments and GET /delivered-webhooks are paginated with page and pageSize (maximum 100); most other lists return everything in one response.

curl https://api.pocketsflow.com/users/me \
  -H "Authorization: Bearer pk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

Keep API keys server-side. Never put a secret key in browser code, a mobile app, a public repository, or a URL.

Account

Read the authenticated account

Method	Endpoint	Description
`GET`	`/users/me`	Get current user information

GET /users/me

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: getCurrentUserResponses

Status	Description
`200`	The account — returns `User`
`401`	Missing or invalid API key
`403`	The account is suspended
`404`	No account exists for these credentials
`410`	The account was deleted
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Checkout

Create hosted checkout links for your products and offers

Method	Endpoint	Description
`POST`	`/checkout/sessions`	Create checkout session

POST /checkout/sessions

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). 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.

Field	Type	Required	Description
`productId`	string	Yes	Id of the product OR subscription offer to purchase.
`successUrl`	string (uri)	No	Absolute http(s) URL to send the buyer to after a successful payment. Optional.
`cancelUrl`	string (uri)	No	Absolute http(s) URL to send the buyer to if they cancel. Optional.
`customerEmail`	string (email)	No	Customer email. Prefills the email on the checkout page (and inside the payment form) and is attached to the resulting order and webhook payload.
`lockEmail`	boolean	No	With customerEmail, makes the prefilled email read-only so the buyer can’t change it.
`clientReferenceId`	string	No	Your own correlation id. Echoed back top-level as `clientReferenceId` on the resulting webhooks, including every subscription lifecycle event.
`discountCode`	string	No	Discount code to apply
`metadata`	object	No	Custom metadata for the checkout, echoed back on webhook payloads. For subscriptions it is captured at activation and replayed on every customer.subscription._ / invoice._ event.

Responses

Status	Description
`201`	Checkout session created — returns `CheckoutSession`
`400`	Missing `productId`, a non-http(s) `successUrl`/`cancelUrl`, invalid `metadata` / `clientReferenceId`, or no store subdomain yet
`401`	Missing or invalid API key
`404`	`productId` is not one of your products or subscription offers
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Customers

Access your customer base

Method	Endpoint	Description
`GET`	`/customers`	List all customers
`GET`	`/customers/{id}`	Get customer by ID

GET /customers

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: listCustomersParameters

Name	Location	Required	Type	Description
`productId`	`query`	No	string	Only customers who bought this product or subscription (any purchase, not just the first)
`sortBy`	`query`	No	string — email, country, numberOfOrders, createdAt; default: `createdAt`	Field to sort by
`sortOrder`	`query`	No	string — asc, desc; default: `desc`	Sort direction

Responses

Status	Description
`200`	List of customers — returns `CustomerListItem[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /customers/{id}

Retrieve a customer with their stats, one-time orders, subscriptions and reviewsOperation ID: getCustomerParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Customer id

Responses

Status	Description
`200`	Customer details — returns `CustomerDetail`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Discounts

Create and manage discount codes

Method	Endpoint	Description
`GET`	`/discounts`	List all discounts
`POST`	`/discounts`	Create a discount
`GET`	`/discounts/{id}`	Get discount by ID
`POST`	`/discounts/{id}`	Update discount
`DELETE`	`/discounts/{id}`	Delete discount
`GET`	`/discounts/apply/{discountCode}/{productId}`	Validate and apply a discount code
`GET`	`/discounts/check-product/{productId}`	Check if a product has discounts

GET /discounts

Retrieve all your discount codes in the key’s mode, each with used (number of sales that used it)Operation ID: listDiscountsResponses

Status	Description
`200`	List of discounts — returns `Discount[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /discounts

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.

Field	Type	Required	Description
`name`	string	Yes	Discount name (non-empty)
`code`	string	Yes	Discount code - what customers enter at checkout
`value`	number	Yes	Greater than 0. Percent off (`percentage`, at most 100) or a fixed decimal amount off in your account currency (`fixed`)
`valueType`	string — percentage, fixed; default: `percentage`	No	Discount type (defaults to percentage)
`mainProductIds`	array of string	Yes	Ids of your own products / subscription offers (in the key’s mode) the discount applies to. Required and non-empty on create.
`active`	boolean; default: `true`	No	Whether discount is active
`expiration`	string (date-time), nullable	No	When the code stops working (ISO 8601). `null` or empty for no expiry.

Responses

Status	Description
`200`	The created discount — returns `Discount`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /discounts/{id}

Retrieve one of your discountsOperation ID: getDiscountParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Discount id

Responses

Status	Description
`200`	The discount — returns `Discount`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /discounts/{id}

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: updateDiscountParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Discount id

Request bodyContent type: application/json No required fields.

Field	Type	Required	Description
`name`	string	No	Discount name (non-empty)
`code`	string	No	Discount code - what customers enter at checkout
`value`	number	No	Greater than 0. Percent off (`percentage`, at most 100) or a fixed decimal amount off in your account currency (`fixed`)
`valueType`	string — percentage, fixed; default: `percentage`	No	Discount type (defaults to percentage)
`mainProductIds`	array of string	No	Ids of your own products / subscription offers (in the key’s mode) the discount applies to. Required and non-empty on create.
`active`	boolean; default: `true`	No	Whether discount is active
`expiration`	string (date-time), nullable	No	When the code stops working (ISO 8601). `null` or empty for no expiry.

Responses

Status	Description
`200`	The updated discount — returns `Discount`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /discounts/{id}

Delete a discount codeOperation ID: deleteDiscountParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Discount id

Responses

Status	Description
`200`	Discount deleted — returns `{ message }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /discounts/apply/{discountCode}/{productId}

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: applyDiscountCodeParameters

Name	Location	Required	Type	Description
`discountCode`	`path`	Yes	string	The discount code the customer entered
`productId`	`path`	Yes	string	Product ID to validate the code against

Responses

Status	Description
`200`	The discount is valid — the discount object is returned — returns `Discount`
`404`	Discount not found, inactive, expired, or not applicable to this product
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /discounts/check-product/{productId}

PUBLIC (no API key) — used by the checkout. Returns true if any discount applies to the given product, false otherwise.Operation ID: checkProductDiscountsParameters

Name	Location	Required	Type	Description
`productId`	`path`	Yes	string	Product ID to check

Responses

Status	Description
`200`	Boolean — whether any discount targets this product — returns `boolean`
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Images

Upload images

Method	Endpoint	Description
`POST`	`/images`	Upload image

POST /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.

Field	Type	Required	Description
`image`	string (binary)	Yes	Image file to upload

Responses

Status	Description
`200`	Image uploaded — returns `{ imageUrl }`
`400`	No file in the `image` field, an unexpected multipart field name, or an invalid multipart upload
`401`	Missing or invalid API key
`413`	File exceeds the authenticated plan’s upload limit
`415`	The file is not a PNG, JPEG, GIF, WebP or AVIF image (checked from the file’s bytes; SVG is rejected) — returns `{ message, allowedTypes: string[] }`
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try 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.

Method	Endpoint	Description
`POST`	`/licenses/validate`	PUBLIC — validate a license key
`POST`	`/licenses/activate`	PUBLIC — activate a key on an instance
`POST`	`/licenses/deactivate`	PUBLIC — free an instance’s activation
`GET`	`/licenses`	List license keys
`GET`	`/licenses/{id}`	Get a license key
`POST`	`/licenses/{id}/disable`	Disable a license key
`POST`	`/licenses/{id}/enable`	Enable a license key
`POST`	`/licenses/{id}/reset-activations`	Reset a license key’s activations

Operation IDs: validateLicenseKey, activateLicenseKey, deactivateLicenseKey, listLicenseKeys, getLicenseKey, disableLicenseKey, enableLicenseKey, resetLicenseKeyActivations.

Link in Bio

Manage your Link in Bio page (creator page): profile, links, theme and which products it shows

Method	Endpoint	Description
`GET`	`/creator-pages`	Get your Link in Bio page
`POST`	`/creator-pages`	Create your Link in Bio page
`PUT`	`/creator-pages`	Update your Link in Bio page
`DELETE`	`/creator-pages`	Delete your Link in Bio page
`PATCH`	`/creator-pages/username`	Change your Link in Bio username
`GET`	`/creator-pages/check-username/{username}`	Check whether a username is available

GET /creator-pages

Retrieve your Link in Bio page configuration and contentOperation ID: getCreatorPageResponses

Status	Description
`200`	Your Link in Bio page — returns `CreatorPage`
`401`	Missing or invalid API key
`404`	You have no Link in Bio page yet — create one with `POST /creator-pages`. Plain-text body.
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /creator-pages

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.

Field	Type	Required	Description
`creatorName`	string	No	Display name at the top of the page. On create it defaults to your account’s first + last name.
`creatorBio`	string	No	Short bio under the name
`username`	string	Yes	Page username — 3-30 letters, numbers, hyphens or underscores, stored lowercase. It is also your store subdomain (`https://{username}.pocketsflow.com`), so changing it moves your storefront. Required when creating. `400` if another account has it.
`socialLinks`	array of object	No	Social profile links (icons). Entries without a non-empty `name` and `url` are dropped; at most 20 are kept.
`regularLinks`	array of object	No	Link buttons shown on the page, in order. Same shape and limits as `socialLinks`.
`profilePicture`	string	No	Profile picture URL. Send an empty string to clear it, or upload a file with `multipart/form-data` (file field `profilePicture`).
`coverImage`	string	No	Cover image URL. Send an empty string to clear it, or upload a file (file field `coverImage`).
`images`	array of string	No	Gallery images (existing image URLs or ids). Omit to keep the current gallery; send an empty value to clear it. Upload files with the `images` file field.
`template`	string — template1, template2, template3, template4, template5, template6, template7, template8	No	Legacy layout template. Unknown values fall back to `template1`.
`theme`	object	No	Legacy theme object (layout, colors, style)
`themeV2`	object	No	Link in Bio v2 theme: `{ templateId, layout (classic\|hero\|storefront), background, button, text, avatar, grainOverlay }`
`gaMeasurementId`	string	No	Google Analytics 4 measurement id (`G-XXXXXXXXXX`); empty string to remove. Invalid values are ignored.
`selectedProductIds`	array of string	No	Products shown on the page. Must be your products in the key’s mode, or the request fails with `400`. Sending this (or `selectedSubscriptionIds`) switches the page to an explicit selection — an empty array hides every product.
`selectedSubscriptionIds`	array of string	No	Subscription offers shown on the page. Same rules as `selectedProductIds`.
`subscriberForm`	object	No	Newsletter sign-up form: `{ enabled, displayType (popup\|embedded), title, description, buttonText, successMessage, popupSettings }`
`bookingEnabled`	boolean	No	Show a booking button on the page
`bookingButtonLabel`	string	No	Label of the booking button
`showFirstName`	boolean; default: `true`	No	Whether your first name may appear on public surfaces
`showLastName`	boolean; default: `true`	No	Whether your last name may appear on public surfaces

Responses

Status	Description
`201`	The created page — returns `CreatorPage`
`400`	You already have a page, the username is invalid or taken, or a selected product is not yours
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff
`502`	An uploaded image could not be stored — retry

Try it in the interactive API explorer.

PUT /creator-pages

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.

Field	Type	Required	Description
`creatorName`	string	No	Display name at the top of the page. On create it defaults to your account’s first + last name.
`creatorBio`	string	No	Short bio under the name
`username`	string	No	Page username — 3-30 letters, numbers, hyphens or underscores, stored lowercase. It is also your store subdomain (`https://{username}.pocketsflow.com`), so changing it moves your storefront. Required when creating. `400` if another account has it.
`socialLinks`	array of object	No	Social profile links (icons). Entries without a non-empty `name` and `url` are dropped; at most 20 are kept.
`regularLinks`	array of object	No	Link buttons shown on the page, in order. Same shape and limits as `socialLinks`.
`profilePicture`	string	No	Profile picture URL. Send an empty string to clear it, or upload a file with `multipart/form-data` (file field `profilePicture`).
`coverImage`	string	No	Cover image URL. Send an empty string to clear it, or upload a file (file field `coverImage`).
`images`	array of string	No	Gallery images (existing image URLs or ids). Omit to keep the current gallery; send an empty value to clear it. Upload files with the `images` file field.
`template`	string — template1, template2, template3, template4, template5, template6, template7, template8	No	Legacy layout template. Unknown values fall back to `template1`.
`theme`	object	No	Legacy theme object (layout, colors, style)
`themeV2`	object	No	Link in Bio v2 theme: `{ templateId, layout (classic\|hero\|storefront), background, button, text, avatar, grainOverlay }`
`gaMeasurementId`	string	No	Google Analytics 4 measurement id (`G-XXXXXXXXXX`); empty string to remove. Invalid values are ignored.
`selectedProductIds`	array of string	No	Products shown on the page. Must be your products in the key’s mode, or the request fails with `400`. Sending this (or `selectedSubscriptionIds`) switches the page to an explicit selection — an empty array hides every product.
`selectedSubscriptionIds`	array of string	No	Subscription offers shown on the page. Same rules as `selectedProductIds`.
`subscriberForm`	object	No	Newsletter sign-up form: `{ enabled, displayType (popup\|embedded), title, description, buttonText, successMessage, popupSettings }`
`bookingEnabled`	boolean	No	Show a booking button on the page
`bookingButtonLabel`	string	No	Label of the booking button
`showFirstName`	boolean; default: `true`	No	Whether your first name may appear on public surfaces
`showLastName`	boolean; default: `true`	No	Whether your last name may appear on public surfaces

Responses

Status	Description
`200`	The updated page — returns `CreatorPage`
`400`	Invalid or taken username, a selected product is not yours, or a validation error
`401`	Missing or invalid API key
`404`	You have no Link in Bio page yet — create it with `POST /creator-pages`
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff
`502`	An uploaded image could not be stored — retry

Try it in the interactive API explorer.

DELETE /creator-pages

Delete your Link in Bio page. Your account subdomain is kept.Operation ID: deleteCreatorPageResponses

Status	Description
`200`	Page deleted — returns `{ message }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	You have no Link in Bio page. Plain-text body.
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

PATCH /creator-pages/username

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.

Field	Type	Required	Description
`username`	string	Yes	3-30 letters, numbers, hyphens or underscores; stored lowercase

Responses

Status	Description
`200`	Username changed — returns `{ username, message }`
`400`	Missing, invalid or taken username
`401`	Missing or invalid API key
`404`	You have no Link in Bio page yet — create it with `POST /creator-pages`
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /creator-pages/check-username/{username}

Check a Link in Bio username / store subdomain before claiming it. Your own current username counts as available.Operation ID: checkCreatorPageUsernameParameters

Name	Location	Required	Type	Description
`username`	`path`	Yes	string	The username to check

Responses

Status	Description
`200`	The username is available — returns `{ message }`
`400`	Invalid format, or already taken
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Orders

View your one-time product orders

Method	Endpoint	Description
`GET`	`/orders`	List all orders
`GET`	`/orders/{id}`	Get order by ID

GET /orders

Retrieve your one-time product orders, newest first, paginated. 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: listOrdersParameters

Name	Location	Required	Type	Description
`startDate`	`query`	No	string (date)	Only orders created on/after this date (ISO 8601). Applied only together with `endDate`; an unparseable date is a `400`.
`endDate`	`query`	No	string (date)	Only orders created on/before this date (ISO 8601). Applied only together with `startDate`.
`productId`	`query`	No	string	Only orders of this product
`page`	`query`	No	integer; default: `1`	1-based page number
`pageSize`	`query`	No	integer; default: `20`	Number of orders per page (maximum 100)

Responses

Status	Description
`200`	A page of orders — returns `{ orders: Order[], pagination: Pagination }`
`400`	Unparseable `startDate` / `endDate`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /orders/{id}

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: getOrderParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Order (sale) id

Responses

Status	Description
`200`	Order details — returns `OrderDetail`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Partners

Become a Pocketsflow partner, refer users, and earn commissions

Method	Endpoint	Description
`GET`	`/partners`	Get my partner profile
`POST`	`/partners`	Become a partner
`POST`	`/partners/register-referral`	Register a referral signup
`GET`	`/partners/referrals`	Get referred users
`GET`	`/partners/referrals/sales`	Get sales from referred users
`GET`	`/partners/stats`	Get partner stats

GET /partners

Retrieve your partner profile including referral code and denormalized stats.Operation ID: getPartnerResponses

Status	Description
`200`	Partner profile — returns `Partner`
`401`	Missing or invalid API key
`404`	Not a partner
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /partners

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: createPartnerResponses

Status	Description
`201`	Partner created successfully — returns `Partner`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`409`	Already a partner
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /partners/register-referral

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.

Field	Type	Required	Description
`referralCode`	string	Yes	The partner’s referral code from the signup link

Responses

Status	Description
`200`	Referral registered successfully
`400`	`referralCode` missing or not a string, the account already has a referral, a self-referral, or the account is more than 30 days old
`401`	Missing or invalid API key
`404`	Invalid or inactive referral code
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /partners/referrals

List all users who signed up using your referral code. Each user includes their live sales count and total revenue in USD.Operation ID: listReferralsParameters

Name	Location	Required	Type	Description
`page`	`query`	No	integer; default: `1`	1-based page number
`limit`	`query`	No	integer; default: `20`	Referred users per page (maximum 100)

Responses

Status	Description
`200`	Paginated list of referred users with live sales count and USD revenue — returns `{ data: object[], pagination: PartnerPagination }`
`401`	Missing or invalid API key
`404`	Not a partner
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /partners/referrals/sales

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: listReferralSalesParameters

Name	Location	Required	Type	Description
`page`	`query`	No	integer; default: `1`	1-based page number
`limit`	`query`	No	integer; default: `20`	Sales per page (maximum 100)

Responses

Status	Description
`200`	Paginated list of live (non-test, non-refunded) sales of referred users. No buyer data is included. — returns `{ data: object[], pagination: PartnerPagination }`
`401`	Missing or invalid API key
`404`	Not a partner
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /partners/stats

Get live-computed aggregated stats: total signups, total sales, total revenue, and total commission earned based on your commission rate.Operation ID: getPartnerStatsResponses

Status	Description
`200`	Aggregated partner stats — returns `{ referralCode, commissionRate, totalSignups, totalSales, totalRevenue, totalCommission, active, createdAt }`
`401`	Missing or invalid API key
`404`	Not a partner
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Payments

Query the unified payment ledger — one-time purchases and subscription renewals — sourced from the payment processor

Method	Endpoint	Description
`GET`	`/payments`	List payments (unified ledger)
`GET`	`/payments/{id}`	Get a payment by ID

GET /payments

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: listPaymentsParameters

Name	Location	Required	Type	Description
`type`	`query`	No	string — one_time, subscription, all; default: `all`	Payment type: `one_time` (product purchases), `subscription` (subscription charges), or `all` (default)
`startDate`	`query`	No	string (date)	Filter payments from this date (ISO 8601)
`endDate`	`query`	No	string (date)	Filter payments until this date (ISO 8601)
`productId`	`query`	No	string	Filter payments by product id
`subscriptionId`	`query`	No	string	Filter payments by subscription offer id
`page`	`query`	No	integer; default: `1`	1-based page number
`pageSize`	`query`	No	integer; default: `20`	Number of payments per page (maximum 100)

Responses

Status	Description
`200`	A page of payments — returns `{ payments: Payment[], pagination: Pagination }`
`400`	Unparseable `startDate` / `endDate`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /payments/{id}

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: getPaymentParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Payment id (the Sale _id)
`live`	`query`	No	boolean; default: `false`	When true, fetch the authoritative live payment from the payments partner and include it as `paymentsPartnerLive`

Responses

Status	Description
`200`	Payment details — returns `PaymentDetail`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Posts

Create, schedule and send newsletter email campaigns, or send one-off emails

Method	Endpoint	Description
`GET`	`/newsletters/posts`	List all posts
`POST`	`/newsletters/posts`	Create a post
`GET`	`/newsletters/posts/{id}`	Get post by ID
`POST`	`/newsletters/posts/{id}`	Update post
`DELETE`	`/newsletters/posts/{id}`	Delete post
`POST`	`/newsletters/posts/{id}/send`	Send post now
`POST`	`/newsletters/send`	Send email

GET /newsletters/posts

Retrieve your newsletter posts, newest first, optionally only one status. Not paginated.Operation ID: listPostsParameters

Name	Location	Required	Type	Description
`status`	`query`	No	string — draft, scheduled, sending, sent, failed, automation	Only posts with this status

Responses

Status	Description
`200`	List of posts — returns `Post[]`
`400`	Unknown `status` value
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /newsletters/posts

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.

Field	Type	Required	Description
`name`	string	Yes	Internal name of the post (shown in your dashboard, not to recipients). Required when creating.
`subject`	string	No	Email subject line
`preview`	string	No	Inbox preview text shown after the subject
`contentHtml`	string	No	HTML body of the email
`contentJson`	object	No	Optional editor document the dashboard composer re-opens. Not used for sending — `contentHtml` is what recipients get.
`fromName`	string	No	Sender display name. Defaults to the default from name in your newsletter settings.
`replyToEmail`	string (email)	No	Reply-to address. Defaults to your configured reply-to (or sender) email.
`status`	string — draft, scheduled, automation; default: `draft`	No	`draft` (default), `scheduled` (send at `scheduledAt`), or `automation` (a template only sent by automations). Other statuses are set by the send flow; values you send outside this list are ignored. Any status other than `draft`/`automation` requires `subject`, `preview`, `fromName` and `contentHtml`.
`scheduledAt`	string (date-time)	No	When to send the post. Use with `status: "scheduled"`; scheduling checks your monthly send allowance (`402` when exceeded).
`scheduledTimezone`	string; default: `UTC`	No	IANA time zone `scheduledAt` is interpreted in
`sendToAll`	boolean; default: `false`	No	Send to every active subscriber
`subscriberIds`	array of string	No	Send to these subscribers (`_id`s from `GET /newsletters/subscribers`)
`productIds`	array of string	No	Send to everyone who bought these products / subscription offers. Ids outside the key’s test/live mode are dropped.
`tags`	array of string	No	Send to subscribers carrying any of these tags

Responses

Status	Description
`200`	The created post — returns `Post`
`400`	Newsletter settings are not configured, or a non-draft status is missing required fields
`401`	Missing or invalid API key
`402`	Scheduling would exceed your monthly send allowance (`code: SEND_ALLOWANCE_EXCEEDED`, plus `used`, `allowance`, `remaining`, `projected`)
`403`	Your account is restricted from sending (`error: SELLER_BLOCKED`), your email sending is paused (`error: EMAIL_SENDING_PAUSED`, scheduling only), scheduling needs a paid plan (`error: PAID_PLAN_REQUIRED`, free plan; drafts stay free) or you have more subscribers than your plan allows (`error: PLAN_LIMIT_EXCEEDED`)
`404`	Not found, not yours, or from the other test/live mode
`429`	New-sender daily limit (`code: DAILY_SEND_LIMIT`), or rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /newsletters/posts/{id}

Retrieve one of your newsletter posts (a malformed id answers 404)Operation ID: getPostParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Post id

Responses

Status	Description
`200`	The post — returns `Post`
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /newsletters/posts/{id}

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: updatePostParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Post id

Request bodyContent type: application/json No required fields.

Field	Type	Required	Description
`name`	string	No	Internal name of the post (shown in your dashboard, not to recipients). Required when creating.
`subject`	string	No	Email subject line
`preview`	string	No	Inbox preview text shown after the subject
`contentHtml`	string	No	HTML body of the email
`contentJson`	object	No	Optional editor document the dashboard composer re-opens. Not used for sending — `contentHtml` is what recipients get.
`fromName`	string	No	Sender display name. Defaults to the default from name in your newsletter settings.
`replyToEmail`	string (email)	No	Reply-to address. Defaults to your configured reply-to (or sender) email.
`status`	string — draft, scheduled, automation; default: `draft`	No	`draft` (default), `scheduled` (send at `scheduledAt`), or `automation` (a template only sent by automations). Other statuses are set by the send flow; values you send outside this list are ignored. Any status other than `draft`/`automation` requires `subject`, `preview`, `fromName` and `contentHtml`.
`scheduledAt`	string (date-time)	No	When to send the post. Use with `status: "scheduled"`; scheduling checks your monthly send allowance (`402` when exceeded).
`scheduledTimezone`	string; default: `UTC`	No	IANA time zone `scheduledAt` is interpreted in
`sendToAll`	boolean; default: `false`	No	Send to every active subscriber
`subscriberIds`	array of string	No	Send to these subscribers (`_id`s from `GET /newsletters/subscribers`)
`productIds`	array of string	No	Send to everyone who bought these products / subscription offers. Ids outside the key’s test/live mode are dropped.
`tags`	array of string	No	Send to subscribers carrying any of these tags

Responses

Status	Description
`200`	The updated post — returns `Post`
`400`	The post was already sent, or a non-draft status is missing required fields
`401`	Missing or invalid API key
`402`	Scheduling would exceed your monthly send allowance (`code: SEND_ALLOWANCE_EXCEEDED`)
`403`	Your account is restricted from sending (`error: SELLER_BLOCKED`), your email sending is paused (`error: EMAIL_SENDING_PAUSED`) or scheduling needs a paid plan (`error: PAID_PLAN_REQUIRED`, free plan; saving a draft stays free)
`404`	Not found, not yours, or from the other test/live mode
`429`	New-sender daily limit (`code: DAILY_SEND_LIMIT`), or rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /newsletters/posts/{id}

Delete a newsletter post (a scheduled post is unscheduled first). Returns the deleted post.Operation ID: deletePostParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Post id

Responses

Status	Description
`200`	The deleted post — returns `Post`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /newsletters/posts/{id}/send

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: sendPostParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Post id

Responses

Status	Description
`200`	The post was queued for sending — returns `{ message, post: Post }`
`400`	Sender email not verified, the post was already sent, or it is an automation post
`401`	Missing or invalid API key
`402`	The send would exceed your monthly send allowance (`code: SEND_ALLOWANCE_EXCEEDED`)
`403`	Your account is restricted from sending (`error: SELLER_BLOCKED`), your email sending is paused after too many bounces or spam reports (`error: EMAIL_SENDING_PAUSED`), sending campaigns needs a paid plan (`error: PAID_PLAN_REQUIRED`, free plan) or you have more subscribers than your plan allows (`error: PLAN_LIMIT_EXCEEDED`)
`404`	Not found, not yours, or from the other test/live mode
`429`	New-sender daily limit (`code: DAILY_SEND_LIMIT`), or rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /newsletters/send

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.

Field	Type	Required	Description
`to`	string (email) \| array of string	Yes	A recipient email address, or an array of 1-100 addresses
`subject`	string	Yes	Email subject line
`html`	string	No	HTML body of the email. Required unless `text` is provided.
`text`	string	No	Plain-text body. Used as the text alternative; if `html` is omitted, a simple HTML body is generated from it.
`fromName`	string	No	Sender display name. Defaults to your newsletter settings’ default from name.
`replyTo`	string (email)	No	Reply-to address. Defaults to your configured reply-to (or sender) email.
`preview`	string	No	Inbox preview text

Responses

Status	Description
`200`	Email sent — or, when every recipient has unsubscribed, nothing sent (`status: "skipped"`, `id: null`, not metered) — returns `{ id, accepted: string[], skipped: string[], skippedCount, status }`
`400`	Validation error (invalid recipients, missing subject/body, …) — returned as `{ error }`
`401`	Missing or invalid API key
`402`	The send would exceed your monthly send allowance (`code: SEND_ALLOWANCE_EXCEEDED`)
`403`	Sender email not verified (`error: EMAIL_SENDER_NOT_VERIFIED`), account restricted (`error: SELLER_BLOCKED`), or email sending paused after too many bounces or spam reports (`error: EMAIL_SENDING_PAUSED`)
`429`	New-sender daily limit (`code: DAILY_SEND_LIMIT`), or rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff
`502`	No emails could be sent (`error: EMAIL_SEND_FAILED`)

Try it in the interactive API explorer.

Products

Create and manage your one-time digital products. Subscription (recurring) offers are a separate resource — see Subscriptions.

Method	Endpoint	Description
`GET`	`/products`	List all products
`POST`	`/products`	Create a product
`GET`	`/products/{id}`	Get product by ID
`DELETE`	`/products/{id}`	Delete product
`POST`	`/products/update/{id}`	Update product
`POST`	`/products/copy/{id}`	Copy a catalog item

GET /products

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: listProductsResponses

Status	Description
`200`	List of products — returns `Product[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /products

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.

Field	Type	Required	Description
`name`	string	Yes	Product name. Required when creating.
`price`	number; default: `0`	No	Price in your account currency (`currency` on `GET /users/me`). Decimal amount in major units (e.g. `29.99`), not cents. `0` makes the product free.
`compareAtPrice`	number	No	Optional merchandising price shown crossed out next to `price`. Display only — it never affects what the buyer is charged.
`description`	string	No	Product description
`subtitle`	string	No	Product subtitle
`published`	boolean; default: `true`	No	Whether the product is published (visible and purchasable). New products are always created published; send `false` on update to unpublish.
`slug`	string	No	URL slug for the product page
`thumbnail`	string	No	Thumbnail image URL. When empty, the first of `images` is used.
`images`	array of string	No	Gallery image references (image ids). Upload new images with `multipart/form-data` (file field `images`).
`hasProductPage`	string — yes, no	No	Whether the product has its own product page. Must be `"yes"` whenever `payWant` is `true` in the same request — otherwise the request is rejected with `400`.
`payWant`	boolean; default: `false`	No	Enable pay-what-you-want pricing. Requires `hasProductPage: "yes"` in the same request.
`minPrice`	number	No	Minimum price for pay-what-you-want (decimal, account currency)
`maxPrice`	number	No	Maximum price for pay-what-you-want (decimal, account currency)
`refundPolicy`	string	No	Id of one of your refund policies (`_id` from `POST /refunds` / `GET /refunds`) — not policy text. Empty string for none.
`showSales`	boolean; default: `true`	No	Show the sales count on the product page
`showReviews`	boolean; default: `true`	No	Show reviews on the product page
`hasFirstName`	boolean; default: `false`	No	Collect the buyer’s first name at checkout
`hasLastName`	boolean; default: `false`	No	Collect the buyer’s last name at checkout
`productType`	string — file, url, course, credits	No	Catalog type. Additive `credits` is prepaid balance with optional auto-refill. Absent on legacy products.
`availability`	string — available, preorder, waitlist	No	`available` (default): on sale. `preorder`: pay now, content unlocks on `releaseAt` (not for `credits`). `waitlist`: no checkout; collects emails.
`releaseAt`	string (date-time)	No	Pre-order release date (ISO 8601). Required with `preorder`; in the future, at most two years away.
`file`	string	No	URL of the downloadable file (file products). Upload a file with `multipart/form-data` (file field `file`).
`url`	string	No	Link delivered to the buyer (url products)
`ctaText`	string	No	Buy-button label key or text (defaults to `buyForPrice`)
`checkoutText`	string	No	Extra text shown on the checkout page
`thankYouText`	string	No	Text shown after a successful purchase
`creditAutoRefill`	object	No	Seller auto-refill setting. `topOffCents` is integer cents (two decimal places). Enabling without a positive top-off is ignored.

Responses

Status	Description
`201`	The created product — returns `Product`
`400`	Validation error — e.g. `payWant` without `hasProductPage: "yes"`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /products/{id}

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: getProductParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Product id

Responses

Status	Description
`200`	The product — returns `Product`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /products/{id}

Delete one of your one-time products. Fires the product.deleted webhook. To delete a subscription (recurring) offer, use DELETE /subscriptions/{id}.Operation ID: deleteProductParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Product id

Responses

Status	Description
`200`	Product deleted — returns `{ message }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /products/update/{id}

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: updateProductParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Product id

Request bodyContent type: application/json No required fields.

Field	Type	Required	Description
`name`	string	No	Product name. Required when creating.
`price`	number; default: `0`	No	Price in your account currency (`currency` on `GET /users/me`). Decimal amount in major units (e.g. `29.99`), not cents. `0` makes the product free.
`compareAtPrice`	number	No	Optional merchandising price shown crossed out next to `price`. Display only — it never affects what the buyer is charged.
`description`	string	No	Product description
`subtitle`	string	No	Product subtitle
`published`	boolean; default: `true`	No	Whether the product is published (visible and purchasable). New products are always created published; send `false` on update to unpublish.
`slug`	string	No	URL slug for the product page
`thumbnail`	string	No	Thumbnail image URL. When empty, the first of `images` is used.
`images`	array of string	No	Gallery image references (image ids). Upload new images with `multipart/form-data` (file field `images`).
`hasProductPage`	string — yes, no	No	Whether the product has its own product page. Must be `"yes"` whenever `payWant` is `true` in the same request — otherwise the request is rejected with `400`.
`payWant`	boolean; default: `false`	No	Enable pay-what-you-want pricing. Requires `hasProductPage: "yes"` in the same request.
`minPrice`	number	No	Minimum price for pay-what-you-want (decimal, account currency)
`maxPrice`	number	No	Maximum price for pay-what-you-want (decimal, account currency)
`refundPolicy`	string	No	Id of one of your refund policies (`_id` from `POST /refunds` / `GET /refunds`) — not policy text. Empty string for none.
`showSales`	boolean; default: `true`	No	Show the sales count on the product page
`showReviews`	boolean; default: `true`	No	Show reviews on the product page
`hasFirstName`	boolean; default: `false`	No	Collect the buyer’s first name at checkout
`hasLastName`	boolean; default: `false`	No	Collect the buyer’s last name at checkout
`productType`	string — file, url, course, credits	No	Catalog type. Additive `credits` is prepaid balance with optional auto-refill. Absent on legacy products.
`availability`	string — available, preorder, waitlist	No	`available` (default): on sale. `preorder`: pay now, content unlocks on `releaseAt` (not for `credits`). `waitlist`: no checkout; collects emails.
`releaseAt`	string (date-time)	No	Pre-order release date (ISO 8601). Required with `preorder`; in the future, at most two years away.
`file`	string	No	URL of the downloadable file (file products). Upload a file with `multipart/form-data` (file field `file`).
`url`	string	No	Link delivered to the buyer (url products)
`ctaText`	string	No	Buy-button label key or text (defaults to `buyForPrice`)
`checkoutText`	string	No	Extra text shown on the checkout page
`thankYouText`	string	No	Text shown after a successful purchase
`creditAutoRefill`	object	No	Seller auto-refill setting. `topOffCents` is integer cents (two decimal places). Enabling without a positive top-off is ignored.

Responses

Status	Description
`200`	The updated product — returns `Product`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /products/copy/{id}

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: copyProductParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Product or subscription offer id to copy

Request bodyContent type: application/json (body optional) No required fields.

Field	Type	Required	Description
`testMode`	boolean	No	Target mode of the copy. Omit to copy within the source’s own mode.

Responses

Status	Description
`201`	The newly created copy (a product or a subscription offer) — returns `Product \| SubscriptionOffer`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

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.

Method	Endpoint	Description
`GET`	`/refunds`	List refund policies
`POST`	`/refunds`	Create a refund policy
`GET`	`/refunds/{id}`	Get refund policy by ID
`POST`	`/refunds/{id}`	Update a refund policy
`DELETE`	`/refunds/{id}`	Delete a refund policy

GET /refunds

Retrieve your refund POLICIES in the key’s mode, newest first, each with appliedTo — how many products use itOperation ID: listRefundPoliciesResponses

Status	Description
`200`	List of refund policies — returns `RefundPolicy[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /refunds

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.

Field	Type	Required	Description
`name`	string	No	Internal name of the policy
`policy`	string	No	Policy text shown to buyers
`period`	number; default: `0`	No	Length of the refund window
`periodType`	string — days, weeks; default: `days`	No	Unit of `period`

Responses

Status	Description
`200`	The created refund policy — returns `RefundPolicy`
`400`	A field has the wrong type (`period` must be a non-negative number, `periodType` `days` or `weeks`)
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /refunds/{id}

PUBLIC (no API key) — retrieve a refund POLICY by its id. Checkout renders it for buyers.Operation ID: getRefundPolicyParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Refund policy id

Responses

Status	Description
`200`	The refund policy — returns `RefundPolicy`
`404`	Refund policy not found
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /refunds/{id}

Update one of your refund POLICIES — only the fields you send change.Operation ID: updateRefundPolicyParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Refund policy id

Request bodyContent type: application/json No required fields.

Field	Type	Required
`name`	string	No
`policy`	string	No
`period`	number	No
`periodType`	string — days, weeks	No

Responses

Status	Description
`200`	The updated refund policy — returns `RefundPolicy`
`400`	A field has the wrong type (`period` must be a non-negative number, `periodType` `days` or `weeks`)
`401`	Missing or invalid API key
`404`	No refund policy of yours with this id
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /refunds/{id}

Delete one of your refund POLICIES. Returns the deleted policy. Products that referenced it keep the stale id — update them.Operation ID: deleteRefundPolicyParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Refund policy id

Responses

Status	Description
`200`	The deleted refund policy — returns `RefundPolicy`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Refund policy not found
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Reviews

Read your product reviews

Method	Endpoint	Description
`GET`	`/reviews`	List product reviews

GET /reviews

Retrieve all reviews across your products in the key’s mode, newest first. Not paginated; filtering is not supported.Operation ID: listReviewsResponses

Status	Description
`200`	List of reviews — returns `Review[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Subscribers

Manage your newsletter email contacts and product audiences

Method	Endpoint	Description
`GET`	`/newsletters/audiences`	List product audiences
`POST`	`/newsletters/audiences/sync`	Add a product’s customers to your subscribers
`GET`	`/newsletters/subscribers`	List all subscribers
`GET`	`/newsletters/subscribers/{id}`	Get subscriber by ID
`DELETE`	`/newsletters/subscribers/{id}`	Remove subscriber

GET /newsletters/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: listProductAudiencesResponses

Status	Description
`200`	Product audiences — returns `object[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /newsletters/audiences/sync

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.

Field	Type	Required	Description
`productId`	string	No	Product or subscription ID. Omit for all buyers.

Responses

Status	Description
`200`	Sync result: `customers` (buyers found), `added` (new contacts), `updated` (existing contacts newly linked), `unsubscribed` (opted-out buyers, linked but never emailed) — returns `{ customers, added, updated, unsubscribed }`
`400`	Invalid productId
`401`	Missing or invalid API key
`403`	Would exceed your plan’s subscriber limit (`error: PLAN_LIMIT_EXCEEDED`)
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /newsletters/subscribers

Retrieve all your newsletter contacts, newest first. Each carries productIds: the products and subscriptions they bought. Not paginated.Operation ID: listEmailSubscribersParameters

Name	Location	Required	Type	Description
`productId`	`query`	No	string	Only contacts in this product audience

Responses

Status	Description
`200`	List of subscribers — returns `EmailSubscriber[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /newsletters/subscribers/{id}

Retrieve one of your newsletter contactsOperation ID: getEmailSubscriberParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscriber id

Responses

Status	Description
`200`	The subscriber — returns `EmailSubscriber`
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /newsletters/subscribers/{id}

Delete a contact from your list. Returns the deleted contact.Operation ID: deleteEmailSubscriberParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscriber id

Responses

Status	Description
`200`	The deleted subscriber — returns `EmailSubscriber`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try 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).

Method	Endpoint	Description
`GET`	`/orders/subscriptions/{id}`	Get a subscriber with payment history (via Orders)
`GET`	`/subscriptions`	List all subscription offers
`POST`	`/subscriptions`	Create a subscription offer
`GET`	`/subscriptions/subscribers`	List subscribers
`GET`	`/subscriptions/subscribers/{id}`	Get a subscriber with payment history
`GET`	`/subscriptions/{id}`	Get subscription offer by ID
`DELETE`	`/subscriptions/{id}`	Delete a subscription offer
`POST`	`/subscriptions/{id}/cancel`	Cancel a subscriber’s subscription
`POST`	`/subscriptions/{id}/pause`	Pause a subscriber’s subscription
`POST`	`/subscriptions/{id}/resume`	Resume a paused subscription

GET /orders/subscriptions/{id}

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: getSubscriberOrderHistoryParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscriber id (the SubscriptionCustomer _id)

Responses

Status	Description
`200`	Subscriber details with payment history — returns `{ subscriptionCustomer: Subscriber, subscription: SubscriptionOffer \| null, customer: Customer \| null, status, payments: Payment[] }`
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /subscriptions

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: listSubscriptionOffersResponses

Status	Description
`200`	List of subscription offers — returns `SubscriptionOffer[]`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /subscriptions

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.

Field	Type	Required	Description
`name`	string	Yes	Subscription offer name
`subtitle`	string	No	Short offer subtitle
`description`	string	No	Offer description
`price`	number	Yes	Recurring price in USD. Decimal amount in major units, not cents.
`frequency`	string — weekly, monthly, yearly	Yes	Billing frequency
`trialPeriod`	integer; default: `0`	No	Trial duration in days
`published`	boolean; default: `true`	No	Whether the offer is published
`redirectBackUrl`	string (uri)	No	Return URL used by the customer billing portal; defaults to https://pocketsflow.com
`refundPolicy`	string	No	Refund policy id (from `POST /refunds`)
`checkoutText`	string	No
`portalText`	string	No
`privacyPolicy`	string (uri)	No
`termsOfService`	string (uri)	No
`thumbnail`	string (uri)	No
`images`	array of string	No	Existing image references or uploaded images in multipart requests
`file`	string \| object	No	File URL or uploaded file reference
`url`	string (uri)	No
`isFile`	boolean	No
`hasFirstName`	boolean; default: `false`	No
`hasLastName`	boolean; default: `false`	No
`callbackUrl`	string (uri)	No
`hasCallbackUrl`	boolean	No
`productType`	string — file, url, course, credits	No	Catalog type. Additive `credits` is prepaid balance with optional auto-refill.
`creditAutoRefill`	object	No	Seller auto-refill setting. `topOffCents` is integer cents.
`ctaText`	string	No
`thankYouText`	string	No
`slug`	string	No
`hasProductPage`	boolean	No
`showSales`	boolean	No
`showReviews`	boolean	No
`maxPrice`	number	No
`minPrice`	number	No
`design`	object	No
`colors`	object	No
`pageStyle`	object	No
`checkoutStyle`	object	No
`checkoutColors`	object	No

Responses

Status	Description
`201`	Subscription offer created successfully — returns `SubscriptionOffer`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /subscriptions/subscribers

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: listSubscribersParameters

Name	Location	Required	Type	Description
`status`	`query`	No	string — incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, succeeded, refunded, paused	Filter subscribers by their payments-partner-sourced status
`buyerEmail`	`query`	No	string	Filter subscribers by buyer email
`email`	`query`	No	string	Alias for buyerEmail
`subscriptionId`	`query`	No	string	Filter subscribers by subscription offer id
`page`	`query`	No	integer; default: `1`	1-based page number
`pageSize`	`query`	No	integer; default: `20`	Number of subscribers per page

Responses

Status	Description
`200`	A page of subscribers — returns `{ subscribers: Subscriber[], pagination: Pagination }`
`400`	`status` is not a known status, or `buyerEmail` / `email` / `subscriptionId` is not a single valid value
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /subscriptions/subscribers/{id}

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: getSubscriberParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscriber id (the SubscriptionCustomer _id)
`live`	`query`	No	boolean; default: `false`	When true, fetch authoritative live membership status from the payments partner and include it as `membership`

Responses

Status	Description
`200`	Subscriber details with payment history — returns `{ subscriber: Subscriber, subscription: SubscriptionOffer \| null, customer: Customer \| null, status, payments: Payment[], membership }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /subscriptions/{id}

Retrieve one of your subscription OFFERS in the key’s mode.Operation ID: getSubscriptionOfferParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscription offer id

Responses

Status	Description
`200`	The subscription offer — returns `SubscriptionOffer`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /subscriptions/{id}

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: deleteSubscriptionOfferParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Subscription offer id

Responses

Status	Description
`200`	Subscription offer deleted — returns `{ message, id }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /subscriptions/{id}/cancel

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: cancelSubscriptionParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	The subscriber’s `_id` (SubscriptionCustomer) or its membership id (`mem_…`), as returned by `GET /subscriptions/subscribers`

Responses

Status	Description
`200`	Subscription canceled successfully — returns `{ success, status, cancelAtPeriodEnd, manageUrl }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /subscriptions/{id}/pause

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: pauseSubscriptionParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	The subscriber’s `_id` (SubscriptionCustomer) or its membership id (`mem_…`), as returned by `GET /subscriptions/subscribers`

Responses

Status	Description
`200`	Subscription paused successfully — returns `{ success, status, paused, cancelAtPeriodEnd, manageUrl }`
`400`	The subscriber has no membership on record, so collection cannot be paused
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff
`502`	The payments partner refused the pause; nothing was changed

Try it in the interactive API explorer.

POST /subscriptions/{id}/resume

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: resumeSubscriptionParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	The subscriber’s `_id` (SubscriptionCustomer) or its membership id (`mem_…`), as returned by `GET /subscriptions/subscribers`

Responses

Status	Description
`200`	Subscription resumed successfully — returns `{ success, status, cancelAtPeriodEnd, manageUrl }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

Upsells

Configure upsell offers shown at checkout

Method	Endpoint	Description
`GET`	`/upsells`	List all upsells
`POST`	`/upsells`	Create an upsell
`GET`	`/upsells/{id}`	Get upsell by ID
`POST`	`/upsells/{id}`	Update upsell
`DELETE`	`/upsells/{id}`	Delete upsell

GET /upsells

Retrieve your upsells in the key’s mode, plus salesWithUpsells — your sales that carry an upsellOperation ID: listUpsellsResponses

Status	Description
`200`	Upsells and the sales that include one — returns `{ upsells: Upsell[], salesWithUpsells: object[] }`
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /upsells

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.Operation ID: createUpsellRequest bodyContent type: application/json Required fields: mainProductIds, upsellProductId, upsellPrice.

Field	Type	Required	Description
`mainProductIds`	array of string	Yes	Product IDs that trigger this upsell (required)
`upsellProductId`	string	Yes	Product ID to offer as upsell (required)
`upsellPrice`	number	Yes	Upsell price (required). Decimal amount in your account currency, not cents.
`compareAtPrice`	number	No	Optional crossed-out price shown next to `upsellPrice`
`name`	string	No	Upsell name
`offer`	string	No	Offer headline text
`upsellDescription`	string	No	Upsell description shown to customer
`primaryButtonText`	string	No	Primary button text (e.g., ‘Yes, add this!’)
`secondaryButtonText`	string	No	Secondary button text (e.g., ‘No thanks’)
`active`	boolean; default: `true`	No	Whether upsell is active
`upsellBackground`	string	No	Card background color override (hex, e.g. ‘#fffbe6’)
`upsellBorder`	string	No	Card border color override (hex, e.g. ‘#d9c98f’)
`upsellHeadline`	string	No	Headline text color override (hex, e.g. ‘#14532d’)
`upsellDescriptionColor`	string	No	Description text color override (hex)
`upsellCheckboxColor`	string	No	Checkbox accent color override (hex)
`upsellCheckboxBackground`	string	No	Unchecked checkbox box fill color override (hex)
`upsellHeadingFont`	string	No	Title font override (font key, e.g. ‘poppins’)
`upsellBodyFont`	string	No	Body font override (font key, e.g. ‘serif’)

Responses

Status	Description
`200`	The created upsell — returns `Upsell`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	`upsellProductId` is not one of your products
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /upsells/{id}

Retrieve one of your upsellsOperation ID: getUpsellParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Upsell id

Responses

Status	Description
`200`	The upsell — returns `Upsell`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /upsells/{id}

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: updateUpsellParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Upsell id

Request bodyContent type: application/json No required fields.

Field	Type	Required	Description
`name`	string	No
`offer`	string	No
`mainProductIds`	array of string	No	Product IDs that trigger this upsell
`upsellProductId`	string	No
`upsellPrice`	number	No
`compareAtPrice`	number	No
`upsellDescription`	string	No
`primaryButtonText`	string	No
`secondaryButtonText`	string	No
`active`	boolean	No
`upsellBackground`	string	No
`upsellBorder`	string	No
`upsellHeadline`	string	No
`upsellDescriptionColor`	string	No
`upsellCheckboxColor`	string	No
`upsellCheckboxBackground`	string	No
`upsellHeadingFont`	string	No
`upsellBodyFont`	string	No

Responses

Status	Description
`200`	The updated upsell — returns `Upsell`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /upsells/{id}

Delete an upsell offerOperation ID: deleteUpsellParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Upsell id

Responses

Status	Description
`200`	Upsell deleted — returns `{ message }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try 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.

Method	Endpoint	Description
`GET`	`/webhooks`	List all webhooks
`POST`	`/webhooks`	Create a webhook
`GET`	`/webhooks/{id}`	Get webhook by ID
`PATCH`	`/webhooks/{id}`	Update webhook
`DELETE`	`/webhooks/{id}`	Delete webhook
`POST`	`/webhooks/{id}/rotate-secret`	Rotate a webhook’s signing secret
`POST`	`/webhooks/{id}/test`	Test webhook
`GET`	`/delivered-webhooks`	List webhook deliveries
`GET`	`/delivered-webhooks/{id}`	Get a webhook delivery
`POST`	`/delivered-webhooks/{id}/redeliver`	Redeliver a webhook

GET /webhooks

Retrieve your webhook endpoints in the key’s mode, newest first. Secrets are omitted.Operation ID: listWebhooksResponses

Status	Description
`200`	Your webhook endpoints — returns `{ webhooks: Webhook[] }`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /webhooks

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.

Field	Type	Required	Description
`url`	string (uri)	Yes	Endpoint URL. Must be https:// and publicly reachable (private / internal addresses are rejected).
`events`	array of string	Yes	Events to subscribe to — a non-empty list of known event types (required)
`description`	string	No	Optional description (at most 500 characters)

Responses

Status	Description
`200`	Webhook created — returns `{ id, url, events: string[], description, secret }`
`400`	Missing, non-https or disallowed `url` (`{ error }`), an empty or unknown `events` list (`{ error, invalidEvents }`), or a `description` over 500 characters
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /webhooks/{id}

Retrieve one of your webhook endpoints, including its signing secretOperation ID: getWebhookParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Webhook id

Responses

Status	Description
`200`	The webhook — returns `{ webhook: Webhook }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

PATCH /webhooks/{id}

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: updateWebhookParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Webhook id

Request bodyContent type: application/json No required fields.

Field	Type	Required	Description
`url`	string (uri)	No	New https:// endpoint URL
`events`	array of string	No	Replaces the subscribed events (non-empty)
`description`	string	No
`active`	boolean	No	`false` pauses deliveries

Responses

Status	Description
`200`	The updated webhook (without `secret`) — returns `{ webhook: Webhook }`
`400`	Invalid id, `url`, `events`, `description`, or a non-boolean `active`
`401`	Missing or invalid API key
`404`	Not found, not yours, or from the other test/live mode
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

DELETE /webhooks/{id}

Delete one of your webhook endpoints in the key’s mode.Operation ID: deleteWebhookParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Webhook id

Responses

Status	Description
`200`	Webhook deleted — returns `{ message }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	No webhook of yours with this id
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /webhooks/{id}/rotate-secret

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: rotateWebhookSecretParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Webhook id

Responses

Status	Description
`200`	The new secret — returns `{ id, secret }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	No webhook of yours with this id
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /webhooks/{id}/test

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: testWebhookParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Webhook id

Responses

Status	Description
`200`	The test delivery outcome (also `200` when your endpoint failed — check `delivered`) — returns `{ message, event, eventId, deliveryId, delivered, status, durationMs, error, results: object[] }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	No webhook of yours with this id
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /delivered-webhooks

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: listWebhookDeliveriesParameters

Name	Location	Required	Type	Description
`page`	`query`	No	integer; default: `1`	1-based page number
`pageSize`	`query`	No	integer; default: `20`	Number of deliveries per page (maximum 100)
`webhookId`	`query`	No	string	Only deliveries to this endpoint
`event`	`query`	No	string — order.completed, order.refunded, product.created, product.updated, product.deleted, review.created, customer.created, customer.subscription.created, customer.subscription.updated, customer.subscription.deleted, customer.subscription.pause, customer.subscription.resumed, customer.subscription.trial_will_end, invoice.created, invoice.upcoming, invoice.payment_succeeded, invoice.payment_failed, payment_intent.succeeded, payment_intent.payment_failed, credit.granted, credit.balance_changed, credit.auto_refill.succeeded, credit.auto_refill.failed, credit.consent.enabled, credit.consent.disabled, test.event	Only deliveries of this event type

Responses

Status	Description
`200`	A page of deliveries — returns `{ deliveredWebhooks: WebhookDelivery[], pagination: Pagination }`
`400`	Non-positive `page` / `pageSize`, a malformed `webhookId`, or an unknown `event`
`401`	Missing or invalid API key
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

GET /delivered-webhooks/{id}

Retrieve one delivery-log entry, including the exact body that was sent.Operation ID: getWebhookDeliveryParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Delivery id

Responses

Status	Description
`200`	The delivery — returns `{ deliveredWebhook: WebhookDelivery }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	No delivery of yours with this id
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try it in the interactive API explorer.

POST /delivered-webhooks/{id}/redeliver

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: redeliverWebhookParameters

Name	Location	Required	Type	Description
`id`	`path`	Yes	string	Delivery id

Responses

Status	Description
`200`	The redelivery outcome (also `200` when your endpoint failed — check `delivered`) — returns `{ message, delivered, deliveryId, eventId, event, attempt, status, durationMs, error }`
`400`	Bad request — malformed JSON or id, or failed validation
`401`	Missing or invalid API key
`404`	The delivery or its webhook endpoint no longer exists
`422`	The stored body cannot be redelivered
`429`	Rate limit exceeded — retry after `Retry-After` seconds
`500`	Server error — retry with backoff

Try 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

Field	Type	Description
`_id`	string	Product id (24-character hex MongoDB ObjectId)
`userId`	string	Owner account id
`name`	string
`subtitle`	string
`description`	string
`price`	number	Price in the seller’s account currency (`currency` on `GET /users/me`). Decimal amount in major currency units (e.g. `29.99`), not cents.
`compareAtPrice`	number	Optional crossed-out merchandising price; display only. Decimal amount in major currency units (e.g. `29.99`), not cents.
`payWant`	boolean	Pay-what-you-want pricing enabled
`minPrice`	number	Pay-what-you-want minimum. Decimal amount in major currency units (e.g. `29.99`), not cents.
`maxPrice`	number	Pay-what-you-want maximum. Decimal amount in major currency units (e.g. `29.99`), not cents.
`published`	boolean
`hasProductPage`	string — yes, no, unknown	Whether the product has its own page (`unknown` on products that never set it)
`slug`	string
`thumbnail`	string	Cover image URL (list responses fall back to the first gallery image)
`images`	array of string	Gallery image ids
`productType`	string — file, url, course, credits	Catalog type. Absent on legacy products.
`availability`	string — available, preorder, waitlist	`available` (default), `preorder` (pay now, unlocks on `releaseAt`) or `waitlist` (no checkout; collects emails)
`releaseAt`	string (date-time)	Pre-order release date. Only set while `availability` is `preorder`.
`releasedAt`	string (date-time)	When the product was last released from pre-order. Read-only.
`file`	string	Primary file URL
`url`	string	Delivered link (url products)
`refundPolicy`	string	Refund policy id, or empty
`showSales`	boolean
`showReviews`	boolean
`hasFirstName`	boolean
`hasLastName`	boolean
`ctaText`	string
`checkoutText`	string
`thankYouText`	string
`creditAutoRefill`	object
`testMode`	boolean	Whether the product lives in test mode
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

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:

Field	Type	Description
`product`	Product \| null	The purchased product (null if it was deleted)
`customer`	object
`country`	string	Buyer country (ISO code)
`gross`	number	Gross amount collected (= grossAmount). Decimal amount in major currency units (e.g. `29.99`), not cents.
`taxes`	number	Tax collected (= taxAmount). Decimal amount in major currency units (e.g. `29.99`), not cents.
`variantId`	string	Purchased variant id, if any
`discountId`	string	Applied discount id, if any
`upsellProduct`	Product \| null	Legacy single upsell product, if one was bought
`upsellAmount`	number	Amount paid for the legacy upsell. Decimal amount in major currency units (e.g. `29.99`), not cents.
`purchasedUpsells`	array of object	Upsells bought with this order

OrderFees

Seller-facing fee breakdown attached to orders. All decimal amounts in the sale currency.

Field	Type	Description
`net`	number	amountBeforeTax − affiliateCut − legacy processor fee. Decimal amount in major currency units (e.g. `29.99`), not cents.
`fee`	number	Legacy processor fee (older card / PayPal sales only). Decimal amount in major currency units (e.g. `29.99`), not cents.
`platformFee`	number	Pocketsflow platform fee, as locked at checkout (in the order currency). Decimal amount in major currency units (e.g. `29.99`), not cents.
`platformFeeSource`	string — stored, estimated, none	`stored` = the fee locked at checkout, converted to the order currency; `estimated` = older sale without a stored fee (2% estimate); `none` = legacy card / PayPal sale with no platform line
`processingFee`	number	Payment processing fee (excludes affiliate commission — see `affiliateFee`). Decimal amount in major currency units (e.g. `29.99`), not cents.
`affiliateFee`	number	Affiliate commission deducted from this sale. Decimal amount in major currency units (e.g. `29.99`), not cents.
`totalTransactionCost`	number, nullable	platformFee + processingFee, decimal. Null until the settled amount is known.
`totalDeductions`	number, nullable	totalTransactionCost + affiliateFee, decimal. Null until the settled amount is known.
`effectiveFeeRate`	number, nullable	totalTransactionCost as a percentage of the pre-tax amount (e.g. `7.9` = 7.9%). Null until the settled amount is known.
`netAmount`	number, nullable	Stored settled net amount for the sale, or null when not recorded. Decimal, not cents.
`affiliateCut`	number	Affiliate commission paid out of this sale. Decimal amount in major currency units (e.g. `29.99`), not cents.

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.

Field	Type	Description
`_id`	string	Payment (sale) id (24-character hex MongoDB ObjectId)
`isSubscription`	boolean	true for subscription payments (initial + renewals); false for one-time product purchases
`billingReason`	string — initial, renewal	Only present on subscription payments: `initial` for the first charge that activates the membership, `renewal` for every recurring charge after it
`amount`	number	Charged amount (after tax), in the payment currency. Decimal amount in major currency units (e.g. `29.99`), not cents.
`grossAmount`	number	Gross amount collected from the buyer. Decimal amount in major currency units (e.g. `29.99`), not cents.
`amountBeforeTax`	number	Amount before tax was applied. Decimal amount in major currency units (e.g. `29.99`), not cents.
`taxAmount`	number	Tax collected on this payment. Decimal amount in major currency units (e.g. `29.99`), not cents.
`currency`	string
`buyerEmail`	string
`firstName`	string
`lastName`	string
`buyerDevice`	object	The buyer’s device and browser at checkout: `type` (mobile, tablet, desktop, bot), `browser`, `browserVersion`, `os`, `osVersion`. Absent on older orders; empty strings mean unknown.
`isRefunded`	boolean
`isDisputed`	boolean
`productId`	string	The product purchased. Empty on subscription payments — use `subscriptionId` instead.
`subscriptionId`	string	The subscription offer this payment belongs to. Empty on one-time product purchases.
`partnerPaymentId`	string	The payments partner payment (receipt) id backing this sale
`partnerPlanId`	string	The payments partner plan id this payment was charged against
`membershipId`	string	The payments partner membership id this subscription payment belongs to (subscription payments only). Matches the subscriber’s `membershipId`.
`createdAt`	string (date-time)

Customer

A buyer of yours. One record per buyer email and test/live mode.

Field	Type	Description
`_id`	string	Customer id (24-character hex MongoDB ObjectId)
`buyerEmail`	string
`firstName`	string
`lastName`	string
`country`	string
`productId`	string	The product of the buyer’s first purchase
`testMode`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Subscriber

A subscriber — a buyer’s membership (SubscriptionCustomer) in one of your subscription offers.

Field	Type	Description
`_id`	string	Subscriber id (24-character hex MongoDB ObjectId)
`buyerEmail`	string
`portalUrl`	string	The subscriber’s hosted self-service portal link, including its `?token=…` capability. Send it to the buyer exactly as returned — it is the only link that can cancel or resume; a hand-built `/portal/{subscriptionId}/{subscriberId}` URL without the token opens read-only. Share it only with that buyer.
`status`	string — incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, succeeded, refunded, paused	Payments-partner-sourced live membership status, maintained by the membership/payment webhooks
`active`	boolean	Whether the membership is currently active
`partnerPlanId`	string	The payments partner PLAN id for this subscriber
`membershipId`	string	The payments partner MEMBERSHIP id. Accepted as `{id}` by the cancel / pause / resume endpoints.
`cancelAtPeriodEnd`	boolean	Whether the membership is scheduled to cancel at the end of the current billing period. Stays `active` until the payments partner deactivates it.
`subscriptionId`	string	The subscription offer this subscriber belongs to
`firstName`	string
`lastName`	string
`country`	string
`createdAt`	string (date-time)
`subscription`	object, nullable	The joined subscription offer

SubscriptionOffer

A recurring subscription offer owned by the authenticated seller

Field	Type	Description
`_id`	string	Subscription offer id (24-character hex MongoDB ObjectId)
`name`	string
`subtitle`	string
`description`	string
`price`	number	Recurring price. Decimal amount in major units, not cents.
`frequency`	string — weekly, monthly, yearly
`trialPeriod`	integer
`published`	boolean
`redirectBackUrl`	string (uri)
`thumbnail`	string (uri)
`images`	array of string
`testMode`	boolean
`productType`	string — file, url, course, credits
`creditAutoRefill`	object
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Discount

Field	Type	Description
`_id`	string	Discount id (24-character hex MongoDB ObjectId)
`name`	string
`code`	string	What buyers enter at checkout
`value`	number	Percent off (`valueType: percentage`) or a fixed decimal amount off in your account currency (`valueType: fixed`)
`valueType`	string — percentage, fixed; default: `percentage`
`mainProductIds`	array of string	Products / subscription offers the code applies to
`active`	boolean
`expiration`	string (date-time), nullable	When the code stops working (checkout rejects it after this date). Absent or null = never expires.
`used`	integer	Sales that used the code (`GET /discounts` only)
`testMode`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Upsell

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

Field	Type	Description
`_id`	string	Upsell id (24-character hex MongoDB ObjectId)
`name`	string
`offer`	string	Offer headline
`mainProductIds`	array of string	Products whose checkout shows this upsell
`upsellProductId`	string	The product being offered
`upsellPrice`	number	Price of the upsell. Decimal amount in major currency units (e.g. `29.99`), not cents.
`compareAtPrice`	number	Crossed-out price shown next to `upsellPrice`. Decimal amount in major currency units (e.g. `29.99`), not cents.
`upsellDescription`	string
`primaryButtonText`	string
`secondaryButtonText`	string
`active`	boolean
`showAtCheckout`	boolean
`upsellBackground`	string
`upsellBorder`	string
`upsellHeadline`	string
`upsellDescriptionColor`	string
`upsellCheckboxColor`	string
`upsellCheckboxBackground`	string
`upsellHeadingFont`	string
`upsellBodyFont`	string
`testMode`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Review

Field	Type	Description
`_id`	string	Review id (24-character hex MongoDB ObjectId)
`productId`	string
`saleId`	string	The order the review belongs to
`buyerEmail`	string
`rating`	number	Star rating, 1–5
`review`	string	Review text
`testMode`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

RefundPolicy

A refund policy — the refund terms shown to buyers at checkout. Products reference it by id (refundPolicy). Not a refund of a payment.

Field	Type	Description
`_id`	string	Refund policy id (24-character hex MongoDB ObjectId)
`name`	string	Internal name
`policy`	string	Policy text shown to buyers
`period`	number	Length of the refund window
`periodType`	string — days, weeks
`appliedTo`	integer	Products using this policy (`GET /refunds` only)
`testMode`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

CheckoutSession

Field	Type	Description
`id`	string	Opaque checkout session id
`url`	string (uri)	Hosted checkout URL on your store subdomain — redirect the buyer here

Webhook

Field	Type	Description
`_id`	string	Webhook id (24-character hex MongoDB ObjectId)
`url`	string (uri)
`description`	string
`events`	array of string
`active`	boolean
`secret`	string	Signing secret. Returned by `POST /webhooks`, `GET /webhooks/{id}` and `POST /webhooks/{id}/rotate-secret` only — never by the list or update responses.
`testMode`	boolean	Mode of the endpoint — it only receives events from that mode
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

WebhookDelivery

One delivery attempt from the webhook delivery log (kept for 30 days)

Field	Type	Description
`_id`	string	Delivery id (24-character hex MongoDB ObjectId)
`webhookId`	string	The endpoint it was sent to
`eventId`	string	The event id (`evt_…`) — shared by retries and redeliveries
`event`	string
`url`	string	Endpoint URL at the time of sending
`webhookData`	string	The exact JSON body that was sent (a string)
`isSuccessful`	boolean	Whether the endpoint answered 2xx
`attempt`	integer	Attempt number (1 = first try)
`status`	integer	HTTP status the endpoint returned, if any
`durationMs`	integer
`error`	string	Failure reason, if any
`isTest`	boolean	`true` for `POST /webhooks/{id}/test` deliveries
`redeliveryOf`	string	The delivery this one replayed (`POST /delivered-webhooks/{id}/redeliver`)
`sentDate`	string (date-time)
`deliveredAt`	string (date-time)
`expiresAt`	string (date-time)	When the log entry is deleted
`testMode`	boolean

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.

Field	Type	Description
`id`	string	Unique event id — the same value as the `X-Pocketsflow-Event-Id` header. Retries of one delivery share it.
`type`	string — order.completed, order.refunded, product.created, product.updated, product.deleted, review.created, customer.created, customer.subscription.created, customer.subscription.updated, customer.subscription.deleted, customer.subscription.pause, customer.subscription.resumed, customer.subscription.trial_will_end, invoice.created, invoice.upcoming, invoice.payment_succeeded, invoice.payment_failed, payment_intent.succeeded, payment_intent.payment_failed, credit.granted, credit.balance_changed, credit.auto_refill.succeeded, credit.auto_refill.failed, credit.consent.enabled, credit.consent.disabled	Event type — the same value as `X-Pocketsflow-Event`
`created`	integer	When the event was created, Unix seconds
`test`	boolean	`true` on deliveries sent by `POST /webhooks/{id}/test`
`webhookId`	string	The endpoint this delivery was sent to (24-character hex MongoDB ObjectId)
`clientReferenceId`	string, nullable	Echo of the `clientReferenceId` passed at checkout (order and subscription events)
`metadata`	object	Echo of the checkout `metadata` (order and subscription events)

Post

A newsletter post (email campaign)

Field	Type	Description
`_id`	string	Post id (24-character hex MongoDB ObjectId)
`name`	string
`subject`	string
`preview`	string
`fromName`	string
`fromEmail`	string	Your verified sender address
`replyToEmail`	string
`contentHtml`	string
`contentJson`	object, nullable
`status`	string — draft, scheduled, sending, sent, failed, automation	`draft` → `scheduled` → `sending` → `sent` (or `failed`). `automation` posts are templates sent only by automations.
`scheduledAt`	string (date-time)
`scheduledTimezone`	string
`sentAt`	string (date-time)
`sentCount`	integer	Recipients the post was delivered to
`failedCount`	integer	Recipients rejected on the last send attempt
`failureReason`	string — SEND_ALLOWANCE_EXCEEDED, SELLER_BLOCKED, EMAIL_SENDING_PAUSED, DAILY_SEND_LIMIT	Why a scheduled send was refused at delivery time (or stopped mid-send: `EMAIL_SENDING_PAUSED`)
`sendToAll`	boolean
`subscriberIds`	array of string
`productIds`	array of string
`tags`	array of string
`source`	string — dashboard, api	`api` for emails sent with `POST /newsletters/send`, `dashboard` otherwise
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

EmailSubscriber

A newsletter contact

Field	Type	Description
`_id`	string	Subscriber id (24-character hex MongoDB ObjectId)
`email`	string
`name`	string
`status`	string — active, unsubscribed, bounced, complained
`tags`	array of string
`productIds`	array of string	Products / subscription offers this contact bought
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

CreatorPage

Your Link in Bio page

Field	Type	Description
`_id`	string	Creator page id (24-character hex MongoDB ObjectId)
`userId`	string
`creatorName`	string
`creatorBio`	string
`username`	string	Page username — also your store subdomain
`profilePicture`	string
`coverImage`	string
`images`	array of string
`template`	string
`theme`	object
`themeV2`	object
`gaMeasurementId`	string
`socialLinks`	array of object
`regularLinks`	array of object
`selectedProductIds`	array of string
`selectedSubscriptionIds`	array of string
`catalogVisibilityConfigured`	boolean	`true` once a selection was saved — then only the selected items are shown
`subscriberForm`	object
`bookingEnabled`	boolean
`bookingButtonLabel`	string
`showFirstName`	boolean
`showLastName`	boolean
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

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.

Field	Type	Description
`_id`	string	Account record id (24-character hex MongoDB ObjectId)
`userId`	string	Stable account id (owner of every resource)
`email`	string (email)
`name`	string
`firstName`	string
`lastName`	string
`creatorName`	string	Store name
`subdomain`	string	Store subdomain — build storefront and product URLs as `https://{subdomain}.pocketsflow.com/…`. Required before `POST /checkout/sessions` works.
`currency`	string	Account currency — product prices are stored in it
`country`	string
`testMode`	boolean	With an API key: the key’s mode (`true` for `pk_test_…`). With a dashboard session: the dashboard toggle.
`canSell`	boolean	Whether the account may currently take payments. `false` while selling is paused.
`hasSales`	boolean	Whether the account has any sale
`createdFirstProduct`	boolean
`statementDescriptor`	string	The store name buyers see on their card statement
`picture`	string	Avatar URL
`currentPlan`	string — free, tier1, tier2, tier3, tier4	Newsletter plan
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Pagination

Field	Type	Description
`totalCount`	integer
`totalPages`	integer
`currentPage`	integer
`pageSize`	integer
`hasMore`	boolean	Whether `currentPage + 1` has results

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.

Field	Type	Description
`message`	string	Human-readable explanation
`error`	string	Short error title (authentication errors) or, on a few endpoints, a machine-readable code such as `PLAN_LIMIT_EXCEEDED`
`code`	string	Machine-readable error code when present, e.g. `COUNTRY_RESTRICTED`, `ACCOUNT_BLOCKED`, `ACCOUNT_DELETED`, `SEND_ALLOWANCE_EXCEEDED`

Need a typed client?

Use the Pocketsflow Node.js SDK for typed server-side calls, or import /docs.json into your preferred OpenAPI generator.

Interactive API explorer

​Conventions

​Account

​Checkout

​Customers

​Discounts

​Images

​Licenses

​Link in Bio

​Orders

​Partners

​Payments

​Posts

​Products

​Refunds

​Reviews

​Subscribers

​Subscriptions

​Upsells

​Webhooks

​Objects

​Product

​Order

​OrderFees

​Payment

​Customer

​Subscriber

​SubscriptionOffer

​Discount

​Upsell

​Review

​RefundPolicy

​CheckoutSession

​Webhook

​WebhookDelivery

​WebhookEvent

​Post

​EmailSubscriber

​CreatorPage

​User

​Pagination

​Error

​Need a typed client?

Conventions

Account

Checkout

Customers

Discounts

Images

Licenses

Link in Bio

Orders

Partners

Payments

Posts

Products

Refunds

Reviews

Subscribers

Subscriptions

Upsells

Webhooks

Objects

Product

Order

OrderFees

Payment

Customer

Subscriber

SubscriptionOffer

Discount

Upsell

Review

RefundPolicy

CheckoutSession

Webhook

WebhookDelivery

WebhookEvent

Post

EmailSubscriber

CreatorPage

User

Pagination

Error

Need a typed client?