NodeRings Docs

List Plans

GET
/v1/plans

Authorization

Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

page?integer
Formatint32
pageSize?integer
Formatint32
isTemplate?boolean

Filter to show only template plans (true) or only non-template plans (false) If not specified, shows both template and non-template plans

endUser?string

Filter by end user type (client, provider, or all) If not specified, shows plans for all end user types based on organization permissions

Value in"END_USER_UNSPECIFIED" | "END_USER_CLIENT" | "END_USER_PROVIDER" | "END_USER_ALL" | "END_USER_USER"
search?string

Search filter for plan name, code, or description

assetType?string

Filter by asset type (vm, gameserver, etc.)

Value in"ASSET_TYPE_UNSPECIFIED" | "ASSET_TYPE_VM" | "ASSET_TYPE_CONTAINER" | "ASSET_TYPE_STORAGE" | "ASSET_TYPE_GAMESERVER" | "ASSET_TYPE_CDN" | "ASSET_TYPE_IP_ADDRESS" | "ASSET_TYPE_DNS" | "ASSET_TYPE_GPU" | "ASSET_TYPE_GENERIC"
billingType?string

Filter by billing type (subscription, usage, etc.) If not specified, shows plans for all billing types

  • BILLING_TYPE_PERCENTAGE: Percentage-based pricing (e.g., 30% of parent plan)
Value in"BILLING_TYPE_UNSPECIFIED" | "BILLING_TYPE_SUBSCRIPTION" | "BILLING_TYPE_USAGE" | "BILLING_TYPE_FREE" | "BILLING_TYPE_PERCENTAGE"
filterComputeType?string

Filter by compute type (optional). If provided, only plans with matching compute type in their name are returned. Examples: "high performance", "high frequency", "general compute", "general purpose", "cpu optimized", "memory optimized", "storage optimized" Filtering is case-insensitive.

filterCode?string

Filter by plan code (optional). If provided, only plans with matching code are returned. Filtering is case-insensitive. Examples: "SC-GC-1C-1G-20", "DC-HF-4C-8G-160" Filtering is case-insensitive.

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/plans?page&pageSize&isTemplate&endUser&search&assetType&billingType&filterComputeType&filterCode" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "plans": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "endUser": "END_USER_UNSPECIFIED",
      "billingPeriod": "BILLING_PERIOD_UNSPECIFIED",
      "planType": "PLAN_TYPE_UNSPECIFIED",
      "billingType": "BILLING_TYPE_UNSPECIFIED",
      "assetCategory": "ASSET_CATEGORY_UNSPECIFIED",
      "assetType": "ASSET_TYPE_UNSPECIFIED",
      "planCategory": "PLAN_CATEGORY_UNSPECIFIED",
      "currency": "string",
      "setupFee": "string",
      "trialDays": 0,
      "trialAvailable": true,
      "gracePeriodDays": 0,
      "autoRenew": true,
      "maxSubscribers": 0,
      "isPublic": true,
      "slaHours": 0,
      "requiresManualApproval": true,
      "effectiveFrom": "2019-08-24T14:15:22Z",
      "effectiveUntil": "2019-08-24T14:15:22Z",
      "externalBillingId": "string",
      "templatePlanId": "string",
      "rulesetIds": [
        "string"
      ],
      "planPrices": [
        {
          "id": "string",
          "pricingModel": "PRICING_MODEL_UNSPECIFIED",
          "chargeTiming": "CHARGE_TIMING_UNSPECIFIED",
          "tierMode": "TIER_MODE_UNSPECIFIED",
          "currency": "string",
          "unitAmount": "string",
          "unitName": "string",
          "unitQuantity": 0,
          "metricName": "string",
          "metricAggregation": "METRIC_AGGREGATION_UNSPECIFIED",
          "packageSize": 0,
          "packagePrice": "string",
          "overagePrice": "string",
          "billingPeriod": "BILLING_PERIOD_UNSPECIFIED",
          "billingInterval": 0,
          "minimumCharge": "string",
          "maximumCharge": "string",
          "freeUnits": 0,
          "freeAmount": "string",
          "prorate": true,
          "metered": true,
          "effectiveFrom": "2019-08-24T14:15:22Z",
          "effectiveUntil": "2019-08-24T14:15:22Z",
          "externalId": "string",
          "productType": "PRODUCT_TYPE_UNSPECIFIED",
          "parentPlanId": "string",
          "minQuantity": 0,
          "maxQuantity": 0,
          "pricingFormula": {},
          "planPrices": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "code": "string",
              "endUser": "END_USER_UNSPECIFIED",
              "billingPeriod": "BILLING_PERIOD_UNSPECIFIED",
              "planType": "PLAN_TYPE_UNSPECIFIED",
              "billingType": "BILLING_TYPE_UNSPECIFIED",
              "assetCategory": "ASSET_CATEGORY_UNSPECIFIED",
              "assetType": "ASSET_TYPE_UNSPECIFIED",
              "planCategory": "PLAN_CATEGORY_UNSPECIFIED",
              "currency": "string",
              "setupFee": "string",
              "trialDays": 0,
              "trialAvailable": true,
              "gracePeriodDays": 0,
              "autoRenew": true,
              "maxSubscribers": 0,
              "isPublic": true,
              "slaHours": 0,
              "requiresManualApproval": true,
              "effectiveFrom": "2019-08-24T14:15:22Z",
              "effectiveUntil": "2019-08-24T14:15:22Z",
              "externalBillingId": "string",
              "templatePlanId": "string",
              "rulesetIds": [
                "string"
              ],
              "planPrices": [],
              "subscriptionIds": [
                "string"
              ],
              "regionIds": [
                "string"
              ],
              "nodeIds": [
                "string"
              ],
              "organizationName": "string",
              "metadata": {},
              "status": "STATUS_UNSPECIFIED",
              "timestamps": {
                "createTime": "2019-08-24T14:15:22Z",
                "updateTime": "2019-08-24T14:15:22Z"
              }
            }
          ],
          "pricingTierIds": [
            "string"
          ],
          "subscriptionTemplateIds": [
            "string"
          ],
          "metricIds": [
            "string"
          ],
          "metadata": {},
          "status": "STATUS_UNSPECIFIED",
          "timestamps": {
            "createTime": "2019-08-24T14:15:22Z",
            "updateTime": "2019-08-24T14:15:22Z"
          }
        }
      ],
      "subscriptionIds": [
        "string"
      ],
      "regionIds": [
        "string"
      ],
      "nodeIds": [
        "string"
      ],
      "organizationName": "string",
      "metadata": {},
      "status": "STATUS_UNSPECIFIED",
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 0
}

Remove Permission From Role DELETE

Previous Page

Subscribe POST

Next Page