Sign in
plan

get/api/v1/plans

Query parameters

pageinteger required

Specifies the starting position of the results

per_pageinteger required

The maximum number of objects to return

product_family_idstring

Filter by a product family

Response

List of plans

Example response

{
  "data": [
    {
      "id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
      "price_components": [
        {
          "fee": {
            "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
          },
          "id": "price_7n42DGM5Tflk9n8mt7Fhc7",
          "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
        }
      ],
      "product_family": {
        "id": "pf_7n42DGM5Tflk9n8mt7Fhc7"
      },
      "trial": {
        "trialing_plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7"
      },
      "version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes