Get a list of all pricing plans | Solvimon

curl https://test.api.solvimon.com/v1/pricing-plans \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "reference": "STANDARD_PLAN_2024",
      "amount_type": "EXCLUDING_TAX",
      "pricing_currencies": [
        "USD"
      ],
      "object_type": "pricing_plan",
      "id": "pp_8f3a2b1c-4d5e-4a6f-9b7c-123456789abc",
      "name": "Standard Pricing Plan 2024",
      "description": "Default standard pricing plan for 2024 fiscal year",
      "customer_id": "cust_9d7f6e5a-3b2c-4d1e-8f9a-abcdef123456",
      "type": "STANDARD",
      "pricing_plan_version_infos": [
        {
          "version": 1,
          "id": "ppv_1a2b3c4d5e6f7g8h9i0j",
          "status": "ACTIVE",
          "rate_card": {
            "start_at": "2024-01-15T09:30:00Z"
          }
        }
      ],
      "pricing_plan_selection_rules": [
        {
          "type": "RESOURCE",
          "resource": {
            "type": "PLATFORM",
            "field": "COUNTRY",
            "comparator": "IN",
            "value": "US",
            "values": [
              "US",
              "CA"
            ]
          }
        }
      ],
      "variant": "DEFAULT"
    }
  ],
  "links": {
    "first": "https://api.solvimon.com/v1/pricing-plans?page=1&limit=1",
    "current": "https://api.solvimon.com/v1/pricing-plans?page=1&limit=1",
    "next": "https://api.solvimon.com/v1/pricing-plans?page=2&limit=1"
  },
  "limit": 1,
  "page": 1,
  "total_number_of_pages": 1
}

Requires the PRICING_PLAN.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

typestringOptional

The type of the pricing plan to filter on.

customer_idstringOptional

The customer resource ID to filter on.

statuses[]list of stringsOptional

Filter pricing plans based on pricing plan version status(es)

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

limitintegerOptional

The amount of records shown in the list.

pageintegerOptional

The page which is going to be shown.

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

Response

datalist of objects

linksobject

limitinteger or null

pageinteger or null

total_number_of_pagesinteger or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors