SOsolvapay
Plans

List plans for a product

Changed on

Retrieves the plans belonging to a product, paginated in-memory. Returns SDK-shaped plans with option money serialized to integer minor units; hidden plans are excluded. The type field is derived from each plan's composable options.

get/v1/sdk/products/{productRef}/plans

Request

Path parameters

productRefstring required
Example:prd_1A2B3C4D

Product reference or ID

Query parameters

limitnumber

Max results (default 50)

offsetnumber

Pagination offset (default 0)

Response

Plans retrieved successfully

limitnumber
offsetnumber
totalnumber

Total number of plans for the product

Example response

{
  "plans": [
    {
      "currency": "USD",
      "currencySymbol": "$",
      "description": "Best for teams getting started",
      "isActive": true,
      "name": "Starter",
      "price": 2999,
      "reference": "pln_1A2B3C4D",
      "requiresPayment": true,
      "status": "active",
      "type": "recurring"
    }
  ]
}

Changes

  • 032545ac8d13Revision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the required property // to the response with the status

  • 8578b7536a9fRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • warning

      removed the optional property // from the response with the status