Products

List products

Retrieve a paginated list of products with powerful filtering options. Products are the core items available for sale. Each product can have multiple variants (different configurations) and offers (different pricing options). Results are sorted by creation date (newest first) by default.

Authorization

Public key
x-fngs-public-key<token>

In: header

Query Parameters

orderDirection?string

GET /v0/products/list Parameter

Value in

  • "ASC"
  • "DESC"
skip?|

GET /v0/products/list Parameter

Formatdouble
Range0 <= value <= 1.7976931348623157e+308
take?|

GET /v0/products/list Parameter

Formatdouble
Range0 <= value <= 1.7976931348623157e+308
archived?|

GET /v0/products/list Parameter

withArchived?|

GET /v0/products/list Parameter

returnCount?|

GET /v0/products/list Parameter

ids?array<>

GET /v0/products/list Parameter

statuses?array<>

GET /v0/products/list Parameter

termOrId?string

GET /v0/products/list Parameter

tagName?string

GET /v0/products/list Parameter

genres?array<>

GET /v0/products/list Parameter

systems?array<>

GET /v0/products/list Parameter

types?array<>

GET /v0/products/list Parameter

projectId?string

GET /v0/products/list Parameter

offers?|

GET /v0/products/list Parameter

orderBy?string

GET /v0/products/list Parameter

Value in

  • "createdAt"
  • "name"
  • "price"

Response Body

application/json

application/json

GET
/v0/products/list
curl -X GET "https://example.com/v0/products/list"
{  "status": "success",  "data": {    "products": [      {        "object": "product",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "DigitalDownload",        "internalId": null,        "name": "",        "description": "",        "developer": null,        "publisher": null,        "pegiRating": "3",        "releaseDate": null,        "systems": null,        "genres": null,        "status": "DRAFT",        "customFields": null      }    ],    "count": -1.7976931348623157e+308  }}

Cancel a pending payment PATCH

Request cancellation of a payment that is still pending — for example to abort an in-progress checkout before it completes. Only payments with status PENDING are eligible; any other status (including PAID, FAILED, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, UNPAID, and EXPIRED) returns an error. Currently only Stripe-processed payments are supported — PayPal payments and subscription plan-change payments cannot be cancelled through this endpoint. This only requests cancellation from the payment processor; it does not mark the payment as cancelled immediately. The payment's status updates to CANCELLED once the processor confirms the cancellation asynchronously.

Create a new product POST

Create a new product with the specified details. Products can be one of several types: - OneTimePayment: Standard products purchased once - Subscription: Products with recurring billing - Membership: Access-based products - GameKey: Digital key distribution After creation, add offers to make the product purchasable.