Create Group API

Create subscription groups (plans) within service groups with pricing, duration, and feature configurations

Plan Management

Create Group API

Define individual subscription plans within service groups. Configure pricing, duration, bandwidth limits, multi-login capabilities, and other plan-specific features.

Subscription Plans

Create distinct plans with unique features.

Flexible Pricing

Set custom prices for each plan.

Feature Control

Configure bandwidth, logins, and more.


Endpoint Overview

MUTATION/graphql

Create a new subscription group within a service group. Define all plan attributes including name, price, duration, bandwidth limits, and device allowances.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

serviceGroupIdInt!Required

The ID of the parent service group this plan belongs to.

nameString!Required

The name of the subscription plan (e.g., "Basic Monthly", "Pro Annual").

descriptionString

Detailed description of the plan and its benefits.

tagNameString

Short tag for the plan (e.g., "BASIC", "PRO", "ENTERPRISE").

priceString!Required

The price of the subscription plan.

durationInt!Required

Duration of the plan in days (30 for monthly, 365 for annual, etc.).

dailyBandwidthString

Daily bandwidth limit (e.g., "unlimited", "10GB").

multiLoginCountInt

Number of simultaneous device connections allowed.

downloadUploadString

Speed limits for download and upload.

ipString

Dedicated IP configuration if applicable.

usernamePostfixString

Postfix added to usernames for this plan.

usernamePostfixIdString

Identifier for the username postfix.


GraphQL Mutation

mutation createGroup($group: GroupEdit!) {
  createGroup(group: $group) {
    id
    name
    description
    tagName
    duration
    price
    dailyBandwidth
    multiLoginCount
    downloadUpload
    ip
  }
}

Variables:

{
  "group": {
    "serviceGroupId": 1,
    "name": "Pro Monthly",
    "description": "Professional VPN plan with 5 device connections",
    "tagName": "PRO",
    "duration": 30,
    "price": "9.99",
    "dailyBandwidth": "unlimited",
    "multiLoginCount": 5,
    "downloadUpload": "unlimited"
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation createGroup($group: GroupEdit!) { createGroup(group: $group) { id name price duration } }",
    "variables": {
      "group": {
        "serviceGroupId": 1,
        "name": "Pro Monthly",
        "price": "9.99",
        "duration": 30,
        "multiLoginCount": 5
      }
    }
  }'

Response

200Group Created Successfully
{
  "data": {
    "createGroup": {
      "id": "15",
      "name": "Pro Monthly",
      "description": "Professional VPN plan with 5 device connections",
      "tagName": "PRO",
      "duration": 30,
      "price": "9.99",
      "dailyBandwidth": "unlimited",
      "multiLoginCount": 5,
      "downloadUpload": "unlimited",
      "ip": null
    }
  }
}
400Service Group Not Found
{
  "errors": [
    {
      "message": "Service group not found",
      "path": ["createGroup"],
      "extensions": {
        "code": "SERVICE_GROUP_NOT_FOUND"
      }
    }
  ],
  "data": null
}

Plan Configuration Examples

Basic Plan

$4.99/mo, 1 device, 5GB daily bandwidth

Pro Plan

$9.99/mo, 5 devices, unlimited bandwidth

Family Plan

$14.99/mo, 10 devices, unlimited bandwidth

Enterprise Plan

Custom pricing, unlimited devices, dedicated IP


Best Practices

Clear Naming

Use descriptive names that indicate tier and duration.

Competitive Pricing

Research market rates when setting prices.

Feature Differentiation

Make each tier offer clear value upgrades.

Test Plans

Create test plans in staging before production.



Service Group Requirement

Groups must belong to a service group. Create the service group first if it doesn't exist, then create groups within it.

Need a Service Group?

Groups are created within service groups. Create a service group first if you don't have one.

Create Service Group