{ "info": { "name": "Hidden API v1", "description": "Every endpoint of the Hidden API. Set apiKey to a key from Developers, API keys; the Public folder needs none.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.sellhidden.com/v1" }, { "key": "apiKey", "value": "" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "item": [ { "name": "Public", "description": "Store data anyone may read. No key.", "item": [ { "name": "Products of a store", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/public/products/:storeSlug", "host": [ "{{baseUrl}}" ], "path": [ "public", "products", ":storeSlug" ], "variable": [ { "key": "storeSlug", "value": "" } ], "query": [ { "key": "categorySlug", "value": "", "description": "Only products in this category.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 50.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] }, "auth": { "type": "noauth" } } }, { "name": "One product", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/public/products/:storeSlug/:slug", "host": [ "{{baseUrl}}" ], "path": [ "public", "products", ":storeSlug", ":slug" ], "variable": [ { "key": "storeSlug", "value": "" }, { "key": "slug", "value": "" } ] }, "auth": { "type": "noauth" } } }, { "name": "Categories of a store", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/public/categories/:storeSlug", "host": [ "{{baseUrl}}" ], "path": [ "public", "categories", ":storeSlug" ], "variable": [ { "key": "storeSlug", "value": "" } ] }, "auth": { "type": "noauth" } } }, { "name": "Visible reviews", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/public/reviews/:storeSlug", "host": [ "{{baseUrl}}" ], "path": [ "public", "reviews", ":storeSlug" ], "variable": [ { "key": "storeSlug", "value": "" } ], "query": [ { "key": "productSlug", "value": "", "description": "Only reviews of this product.", "disabled": true }, { "key": "rating", "value": "", "description": "Only this star rating.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 20.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] }, "auth": { "type": "noauth" } } }, { "name": "Recent sales", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/public/recent-sales/:storeSlug", "host": [ "{{baseUrl}}" ], "path": [ "public", "recent-sales", ":storeSlug" ], "variable": [ { "key": "storeSlug", "value": "" } ], "query": [ { "key": "limit", "value": "", "description": "Page size. Default 10.", "disabled": true } ] }, "auth": { "type": "noauth" } } } ] }, { "name": "Products", "description": "Your catalogue as the seller sees it: hidden products included, every variation with its deliverables, key pools and order counts. Writes follow the dashboard rules: plan limits, unique slugs, deliverable checks, the 2,000,000-key cap per variation and an audit log entry.", "item": [ { "name": "List products", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "active", "value": "", "description": "Only live or only hidden products.", "disabled": true }, { "key": "categoryId", "value": "", "description": "Only this category.", "disabled": true }, { "key": "q", "value": "", "description": "Title or slug contains this text.", "disabled": true }, { "key": "deliveryType", "value": "", "description": "Primary delivery type (file, text, keys, link, discord, dynamic).", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 50.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Lifetime license\",\n \"description\": \"One key, forever.\",\n \"variants\": [\n {\n \"label\": \"1 device\",\n \"priceUsd\": 29,\n \"deliverables\": [\n {\n \"type\": \"keys\",\n \"keys\": [\n \"AAAA-1111\",\n \"BBBB-2222\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "A product has at least one variation. Send `variants` (recommended), or the short form `priceUsd` + `deliveryType` + `deliveryData` (+ `keys` for a key product) for a single-price product." } }, { "name": "Get a product", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Only the fields you send change. `variants` replaces the whole variation list (variations left out are removed); to change one variation use the Variations endpoints instead." } }, { "name": "Delete a product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Deleted for good when it was never ordered; archived (hidden, kept for order history) otherwise. `result` says which." } }, { "name": "List variations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products/:id/variations", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "variations" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Add a variation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/variations", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "variations" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"5 devices\",\n \"priceUsd\": 49,\n \"compareAtUsd\": 69,\n \"maxPerOrder\": 3,\n \"deliverables\": [\n {\n \"type\": \"keys\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a variation", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products/:id/variations/:variationId", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "variations", ":variationId" ], "variable": [ { "key": "id", "value": "" }, { "key": "variationId", "value": "" } ] } } }, { "name": "Update a variation", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/variations/:variationId", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "variations", ":variationId" ], "variable": [ { "key": "id", "value": "" }, { "key": "variationId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"priceUsd\": 39,\n \"minPerOrder\": 1,\n \"maxPerOrder\": 5\n}", "options": { "raw": { "language": "json" } } }, "description": "Only the fields you send change. Sending `deliverables` replaces that variation's deliverables." } }, { "name": "Remove a variation", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/products/:id/variations/:variationId", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "variations", ":variationId" ], "variable": [ { "key": "id", "value": "" }, { "key": "variationId", "value": "" } ] }, "description": "A product keeps at least one variation (409 otherwise). A variation that was ordered is archived so its orders still deliver." } }, { "name": "Pool counts and unused keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products/:id/keys", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "keys" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "variationId", "value": "", "description": "Which pool. Default: the product's only variation, else the product-wide shared pool.", "disabled": true }, { "key": "q", "value": "", "description": "Key value contains this text.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] }, "description": "`pool` holds the counts (unused, used, shared pool, per variation); `keys` is one page of unused keys of one pool, oldest first." } }, { "name": "Add keys in bulk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/keys", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "keys" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"keys\": [\n \"AAAA-1111\",\n \"BBBB-2222\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Up to 50,000 keys per request (send big lists in batches); a pool holds up to 2,000,000 unused keys (400 pool_full past that). Keys already in the product's pools and repeats in the list are skipped. Orders that were waiting for keys are delivered, oldest first." } }, { "name": "Remove unused keys", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/keys", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "keys" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"AAAA-1111\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Removes up to 500 unused keys by id or by value. Keys already handed to a buyer are never removed." } }, { "name": "Set or adjust stock", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/stock", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "stock" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"adjust\": 10\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets (`stock`) or shifts (`adjust`, can be negative) the stock of one variation. Variations that deliver keys answer 409 stock_from_keys: add or remove keys instead." } } ] }, { "name": "Categories", "description": "Up to 100 categories per store. Deleting one leaves its products uncategorised.", "item": [ { "name": "List categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] } } }, { "name": "Create a category", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Software\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a category", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a category", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Licenses\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a category", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Reorder categories", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/categories/reorder", "host": [ "{{baseUrl}}" ], "path": [ "categories", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"order\": [\n \"clx1\",\n \"clx2\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Coupons", "description": "Discount codes. The code and the discount are fixed once created (orders keep what they used); every other rule can change.", "item": [ { "name": "List coupons", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ], "query": [ { "key": "active", "value": "", "description": "Only usable codes (active and not expired), or only unusable ones.", "disabled": true }, { "key": "code", "value": "", "description": "Code contains this text.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 50.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Create a coupon", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"LAUNCH20\",\n \"percentOff\": 20,\n \"maxUses\": 100,\n \"expiresAt\": \"2026-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a coupon", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a coupon", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Any rule except code, percentOff and amountOffUsd. null clears a limit or a date; null or [] clears a list." } }, { "name": "Delete a coupon", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Orders", "description": "Orders are created by buyers at checkout. The API reads them and runs the same actions as the dashboard: approve or reject a manual payment, cancel, redeliver, resend the receipt, refund to store balance, keep a private note. Every order has a short reference in `publicRef` (for example `7K2Q-9XHD`, or `NOVA-7K2Q-9XHD` when the store has an order ID prefix): it is what buyers see on their order page and receipts, and it works wherever `{id}` appears in an order path, next to the long `id`.", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [ { "key": "status", "value": "", "description": "pending, awaiting_verification, paid, delivered, cancelled, underpaid, oversold, expired, failed, refunded.", "disabled": true }, { "key": "kind", "value": "", "description": "Product orders or buyer balance top-ups.", "disabled": true }, { "key": "email", "value": "", "description": "Buyer email contains this text.", "disabled": true }, { "key": "since", "value": "", "description": "Created at or after.", "disabled": true }, { "key": "until", "value": "", "description": "Created before.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 25.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Get an order", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "{id} is the order's `publicRef` (any case, hyphen optional) or its long id." } }, { "name": "Approve a manual payment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "approve" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Marks the order as paid and delivers it. A manual-method claim is verified (the platform fee is debited from your balance); a crypto order that received part of its total is settled on what arrived; any other payable order is settled as paid outside the platform, which needs `confirmOutsidePlatform: true` while its invoice is still open (409 invoice_open otherwise)." } }, { "name": "Reject a manual payment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "reject" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"No payment received.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancels a manual-method order with the reason; the buyer is emailed." } }, { "name": "Cancel an order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Pending, awaiting-verification, underpaid or expired orders. An order holding a partial crypto payment answers 409 partial_payment: approve or refund it instead." } }, { "name": "Run delivery again", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "redeliver" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "For a paid order with items still not delivered (oversold, failed). 409 already_delivered when everything was delivered: resend the receipt instead." } }, { "name": "Resend the receipt", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/resend-receipt", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "resend-receipt" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Emails the buyer their receipt and items again. Paid orders only; 3 per order and 60 per store per hour." } }, { "name": "Refund to store balance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/refund", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "refund" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Duplicate purchase.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The buyer receives store credit. A paid order is refunded in full or for `amountUsd`; an underpaid or expired order with a partial crypto payment hands over everything that arrived." } }, { "name": "Write the private note", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:id/note", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "note" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"note\": \"Verified by hand on 2026-10-01.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "A note only you see (API and dashboard, as `order.note`). POST works the same." } }, { "name": "Remove the private note", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/orders/:id/note", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "note" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Subscriptions", "description": "Buyers of a variation billed per period (weekly to yearly). Renewals are fresh orders the buyer pays from the renewal email or the order page, or from their store balance; after the grace period access ends by itself. The subscription.* webhook events carry the same shape.", "item": [ { "name": "List subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "subscriptions" ], "query": [ { "key": "status", "value": "", "description": "Only this status.", "disabled": true }, { "key": "email", "value": "", "description": "Buyer email contains this text.", "disabled": true }, { "key": "product", "value": "", "description": "Product id.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 25.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Get a subscription", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "subscriptions", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Cancel a subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/subscriptions/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "subscriptions", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "By default the buyer keeps access until the period end and nothing more is charged (cancelAtPeriodEnd). With immediate: true access ends now: Discord roles are removed, the pending renewal order is cancelled and subscription.expired is sent with the keys it delivered." } }, { "name": "Extend by one period", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/subscriptions/:id/extend", "host": [ "{{baseUrl}}" ], "path": [ "subscriptions", ":id", "extend" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Adds one billing period for free from the current end (or from now when it already ended) and brings an expired or cancelled subscription back, Discord roles included." } } ] }, { "name": "Customers", "description": "Everyone who checked out or signed in on your storefront, with lifetime aggregates.", "item": [ { "name": "List customers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "key": "email", "value": "", "description": "Email contains this text.", "disabled": true }, { "key": "hasAccount", "value": "", "description": "Only buyers who signed in (or only guests).", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 50.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Get a customer", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "With aggregates and the ten most recent orders." } }, { "name": "Adjust store balance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/balance", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "balance" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amountUsd\": 10,\n \"reason\": \"Goodwill credit for the delayed delivery.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds (positive) or removes (negative) store credit. The balance never goes below zero (409 balance_too_low). The reason is written to the audit log." } }, { "name": "Ban a customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/ban", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "ban" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Chargeback.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Blocks the buyer's email at checkout (a blacklist rule you also see under Blacklist in the dashboard)." } }, { "name": "Lift a ban", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customers/:id/ban", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "ban" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Reviews", "description": "Buyer reviews with unmasked emails. Reviews are never deleted: hide spam instead, or answer in public.", "item": [ { "name": "List reviews", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reviews", "host": [ "{{baseUrl}}" ], "path": [ "reviews" ], "query": [ { "key": "productId", "value": "", "description": "Only this product.", "disabled": true }, { "key": "rating", "value": "", "description": "Only this rating.", "disabled": true }, { "key": "visible", "value": "", "description": "Only shown or only hidden reviews.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 50.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Get a review", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reviews/:id", "host": [ "{{baseUrl}}" ], "path": [ "reviews", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Hide or show a review", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/reviews/:id", "host": [ "{{baseUrl}}" ], "path": [ "reviews", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"visible\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reply in public", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/reviews/:id/reply", "host": [ "{{baseUrl}}" ], "path": [ "reviews", ":id", "reply" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reply\": \"Thanks for the kind words!\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Writes or edits the store's reply under the review. The buyer is emailed once per review, on the first reply. Automatic ratings cannot be answered (409 review_automatic). POST works the same." } }, { "name": "Remove the reply", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/reviews/:id/reply", "host": [ "{{baseUrl}}" ], "path": [ "reviews", ":id", "reply" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Tickets", "description": "Support threads buyers open from their order or account. Replies email the buyer.", "item": [ { "name": "List tickets", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "tickets" ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "email", "value": "", "description": "Buyer email contains this text.", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 25.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } }, { "name": "Get a ticket", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "With its full thread; `fromBuyer` tells you who wrote each message." } }, { "name": "Reply to a ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tickets/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id", "messages" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Sorry about that. A new key is on its way.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The ticket becomes answered and the buyer is emailed. A closed ticket must be reopened first." } }, { "name": "Change the status", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"open\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Close a ticket", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tickets/:id/close", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id", "close" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Store", "description": "Your store as its seller sees it, and the basic settings. Themes, payment methods, payouts and domains stay in the dashboard.", "item": [ { "name": "Get the store", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/store", "host": [ "{{baseUrl}}" ], "path": [ "store" ] } } }, { "name": "Update basic settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/store", "host": [ "{{baseUrl}}" ], "path": [ "store" ] }, "body": { "mode": "raw", "raw": "{\n \"maintenanceMode\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Only the fields you send change." } } ] }, { "name": "Webhooks", "description": "Manage the endpoints that receive signed events (the same ones as Developers, Webhooks). The signing secret is returned once, on create and on rotate.", "item": [ { "name": "List endpoints", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } } }, { "name": "Create an endpoint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/hooks/hidden\",\n \"events\": [\n \"order.paid\",\n \"order.delivered\"\n ],\n \"label\": \"Fulfilment\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Public https URLs only. Counts against the plan's endpoint limit (403 plan_limit)." } }, { "name": "Get an endpoint", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update an endpoint", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"resetFailures\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an endpoint", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Rotate the secret", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "rotate-secret" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns the new secret once. Deliveries are signed with it from now on." } }, { "name": "Send a test event", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "A signed webhook.test delivery (10 per endpoint per minute). The response carries the delivery row with the status code your endpoint returned." } }, { "name": "Delivery log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "", "description": "Page size. Default 25.", "disabled": true }, { "key": "cursor", "value": "", "description": "nextCursor from the previous page.", "disabled": true } ] } } } ] }, { "name": "Analytics", "description": "Revenue and order statistics.", "item": [ { "name": "Revenue and orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/analytics", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "key": "period", "value": "", "description": "Window ending now. Default 30d.", "disabled": true } ] } } } ] }, { "name": "Your key", "item": [ { "name": "Inspect the key you are using", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ] }, "description": "Any valid key: its store, scopes, expiry and the rate-limit window. Handy to check a key without touching data." } } ] } ] }