How a workspace works
The building blocks — workspace, members, products, plans, credential sets, customers, payments — and the Overview screen.
A workspace is your store on the platform. It has its own members, products, gateways, customers and payments, and nobody outside it can see them. The platform takes no fee from your payments: money goes straight from the buyer to your own provider account.
The building blocks#
| Term | What it is |
|---|---|
| Member | A person who signs in to the workspace: Owner, Admin or Finance viewer (Members and roles). |
| Credential set | Your API keys for one provider account (Stripe, PayPal, Square or Authorize.net) in one environment, test or live (Gateways). |
| Product | Something you sell. It has a pay page at /pay/<workspace>/<product>, a refund policy and a list of providers (Products and plans). |
| Plan | A price of a product: free, one-time, monthly, quarterly or annual, with an optional free trial. A product can have several plans. |
| Customer | A buyer, identified by email address within your workspace. Customers can have an account to see receipts and manage subscriptions. |
| Payment (transaction) | One charge, with a status and, once paid, a confirmation code ENC-XXXX-XXXX-CC (Payments and statuses). |
| Subscription | A recurring plan of one customer, renewed by the provider (Subscriptions). |
Text description
1. The buyer chooses a plan and a provider on the pay page. 2. The server creates a checkout and sends the buyer to the provider's hosted page. 3. The buyer pays there; card or bank details never reach this server. 4. The provider sends the buyer back to the return page, which only shows "confirming". 5. The provider's signed webhook confirms the payment; only then the payment becomes Paid and gets its confirmation code. 6. The receipt email with the code goes out and the customer account shows the payment.
How money and status move#
- Buyers pay on the provider's hosted page. Card and bank details never reach this server.
- A payment is Paid only when the provider's signed webhook confirms it. The return page the buyer sees is only a hint. That is why every credential set needs its webhook registered.
- Refunds, disputes, renewals and cancellations arrive the same way and update the payment or subscription by themselves.
The Overview screen#
- Revenue, last 30 days — gross revenue of paid payments, as a figure and a sparkline. Admins limited to some products see only those products.
- Getting started — the setup steps that are still open: add a gateway, verify it, create a product, take a test payment. It disappears when everything is done.
- Insights — the main findings of the financial analysis; Analytics and insights explains them.
Open Help (the ? at the top right of every screen) for the page that explains the screen you are on.