v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB

Products

Get a product by reference

Retrieves a product by its reference or ID, including embedded plans.

get/v1/sdk/products/{productRef}

Path parameters

productRefstring required

Example:prd_1A2B3C4D

Product reference or ID

Response

Product retrieved successfully

balancenumber required

Product balance in cents

createdAtstring required

Creation timestamp

descriptionstring

Product description

imageUrlstring

URL to the product image

isMcpPayboolean required

Whether this product uses the no-code MCP integration (SolvaPay reverse proxy)

mcpobject

MCP linkage details for MCP-enabled products

metadataobject

Arbitrary key-value metadata

namestring required

Product name

productTypestring

Free-form product type

referencestring required

Product reference

statusstring required

Product status

totalTransactionsnumber required

Total number of transactions

updatedAtstring required

Last update timestamp

Example response

{
  "config": {
    "deliveryMethod": "api",
    "fulfillmentType": "digital",
    "validityPeriod": 30
  },
  "mcp": {
    "defaultPlanRef": "pln_FREE123",
    "mcpProxyUrl": "https://acme-docs.mcp.solvapay.com/mcp",
    "mcpServerRef": "mcp_ABC123",
    "mcpSubdomain": "acme-docs",
    "originUrl": "https://origin.example.com/mcp"
  },
  "name": "AI Writing Assistant",
  "plans": [
    {
      "billingCycle": "monthly",
      "billingModel": "pre-paid",
      "creditsPerUnit": 1,
      "currency": "USD",
      "currencySymbol": "$",
      "freeUnits": 1000,
      "isActive": true,
      "limit": 10000,
      "measures": "requests",
      "meterRef": "mtr_1A2B3C4D",
      "price": 2999,
      "reference": "pln_1A2B3C4D",
      "requiresPayment": true,
      "setupFee": 500,
      "status": "active",
      "trialDays": 14
    }
  ],
  "reference": "prd_1A2B3C4D",
  "status": "active"
}