Groups API

Retrieve all subscription plans within a specific service group

Groups

Groups API

Access all subscription plans belonging to a specific service group. View plan details, pricing, and configuration options for each group.

Filtered Results

Plans by service group.

Plan Catalog

All available options.

Full Details

Complete plan configurations.


Endpoint Overview

QUERY/graphql

Retrieve all subscription groups (plans) that belong to a specific service group ID.

Authentication:Bearer Token
Required scopes:adminreseller

Request Parameters

serviceGroupIdInt!Required

The ID of the service group to retrieve plans from.


GraphQL Query

query groups($serviceGroupId: Int!) {
  groups(serviceGroupId: $serviceGroupId) {
    id
    name
    description
    tagName
    duration
    price
    usernamePostfix
    usernamePostfixId
    dailyBandwidth
    multiLoginCount
    downloadUpload
    ip
  }
}

Variables:

{
  "serviceGroupId": 1
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query groups($serviceGroupId: Int!) { groups(serviceGroupId: $serviceGroupId) { id name price duration multiLoginCount } }",
    "variables": {
      "serviceGroupId": 1
    }
  }'

Response

200Groups Retrieved Successfully
{
  "data": {
    "groups": [
      {
        "id": "101",
        "name": "Premium Monthly",
        "description": "Premium monthly subscription",
        "tagName": "premium-1m",
        "duration": 30,
        "price": 9.99,
        "usernamePostfix": "@premium",
        "usernamePostfixId": "1",
        "dailyBandwidth": "unlimited",
        "multiLoginCount": 5,
        "downloadUpload": "100/100",
        "ip": "dynamic"
      },
      {
        "id": "102",
        "name": "Premium Quarterly",
        "description": "Premium 3-month subscription",
        "tagName": "premium-3m",
        "duration": 90,
        "price": 24.99,
        "usernamePostfix": "@premium",
        "usernamePostfixId": "1",
        "dailyBandwidth": "unlimited",
        "multiLoginCount": 5,
        "downloadUpload": "100/100",
        "ip": "dynamic"
      },
      {
        "id": "103",
        "name": "Premium Annual",
        "description": "Premium yearly subscription",
        "tagName": "premium-12m",
        "duration": 365,
        "price": 79.99,
        "usernamePostfix": "@premium",
        "usernamePostfixId": "1",
        "dailyBandwidth": "unlimited",
        "multiLoginCount": 5,
        "downloadUpload": "100/100",
        "ip": "dynamic"
      }
    ]
  }
}
404Service Group Not Found
{
  "errors": [
    {
      "message": "Service group not found",
      "path": ["groups"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

Response Fields

idID!

Unique identifier for the subscription plan.

nameString!

Display name of the plan.

descriptionString

Plan description.

tagNameString

Short identifier tag.

durationInt!

Subscription duration in days.

priceFloat!

Base price for the plan.

multiLoginCountInt!

Maximum concurrent connections.

dailyBandwidthString

Daily bandwidth limit.

downloadUploadString

Speed limits in Mbps.

ipString

IP assignment type.


Use Cases

Pricing Page

Display plans for a service tier.

Plan Selection

Show options during checkout.

Reseller Dashboard

View assignable plans.

Comparison Tables

Build feature comparisons.



Service Group Hierarchy

Groups belong to service groups. A service group defines the discount tiers, while individual groups define the specific plan configurations and base pricing.

View All Plans

See every subscription plan across all service groups.

All Groups