Get a pricing plan | Solvimon

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

{
  "reference": "PLAN-STD-2024",
  "amount_type": "EXCLUDING_TAX",
  "pricing_currencies": [
    "USD"
  ],
  "object_type": "pricing_plan",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Standard Subscription Plan",
  "description": "Access to all standard features with monthly billing.",
  "customer_id": "cust-987654321",
  "type": "STANDARD",
  "pricing_plan_version_infos": [
    {
      "version": 3,
      "id": "ver-20240601-001",
      "status": "ACTIVE"
    }
  ],
  "pricing_plan_selection_rules": [
    {
      "type": "RESOURCE",
      "resource": {
        "type": "PLATFORM",
        "field": "COUNTRY",
        "comparator": "EQUALS",
        "value": "US",
        "values": [
          "US",
          "CA",
          "GB"
        ]
      }
    }
  ]
}

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

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Response

referencestringformat: "^\S+$"0-256 characters

amount_typeenum

Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.

Allowed values:

pricing_currencieslist of enums

The default alphabetic currency code representing the type of currency that can be used for the pricings.

object_typestring or nullRead-only

idstring or nullRead-only

namestring or nullformat: "^.*$"0-256 characters

descriptionstring or nullformat: "^.*$"0-256 characters

customer_idstring or null

Resource ID of type CUSTOMER

typeenum or null

Allowed values:

pricing_plan_version_infoslist of objects or nullRead-only

pricing_plan_selection_ruleslist of objects or null

variantenum or nullRead-only

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors