Registration Groups API

Retrieve subscription plans available for new user registration

Groups

Registration Groups API

Access subscription plans that are enabled for new user registration. These are the plans displayed during the signup flow.

Registration Plans

Signup-enabled groups.

Curated Options

Pre-approved plans.

Quick Start

Ready for new users.


Endpoint Overview

QUERY/graphql

Retrieve all subscription groups that are enabled for display during user registration. These plans are available for new users to select during signup.

Authentication:Bearer Token
Required scopes:publicadmin

GraphQL Query

query registrationGroups {
  registrationGroups {
    id
    name
    description
    tagName
    duration
    price
    usernamePostfix
    usernamePostfixId
    dailyBandwidth
    multiLoginCount
    downloadUpload
    ip
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query registrationGroups { registrationGroups { id name description price duration multiLoginCount } }"
  }'

Response

200Registration Groups Retrieved Successfully
{
  "data": {
    "registrationGroups": [
      {
        "id": "10",
        "name": "Free Trial",
        "description": "7-day free trial with limited features",
        "tagName": "trial",
        "duration": 7,
        "price": 0,
        "usernamePostfix": "@trial",
        "usernamePostfixId": "10",
        "dailyBandwidth": "1GB",
        "multiLoginCount": 1,
        "downloadUpload": "10/10",
        "ip": "dynamic"
      },
      {
        "id": "100",
        "name": "Basic Monthly",
        "description": "Essential VPN protection",
        "tagName": "basic",
        "duration": 30,
        "price": 4.99,
        "usernamePostfix": "@basic",
        "usernamePostfixId": "1",
        "dailyBandwidth": "10GB",
        "multiLoginCount": 2,
        "downloadUpload": "50/50",
        "ip": "dynamic"
      },
      {
        "id": "101",
        "name": "Premium Monthly",
        "description": "Full-featured VPN experience",
        "tagName": "premium",
        "duration": 30,
        "price": 9.99,
        "usernamePostfix": "@premium",
        "usernamePostfixId": "2",
        "dailyBandwidth": "unlimited",
        "multiLoginCount": 5,
        "downloadUpload": "100/100",
        "ip": "dynamic"
      }
    ]
  }
}
200No Registration Groups Available
{
  "data": {
    "registrationGroups": []
  }
}

Response Fields

idID!

Unique identifier for the subscription plan.

nameString!

Display name shown during registration.

descriptionString

Plan description for users.

tagNameString

Short identifier tag.

durationInt!

Subscription duration in days.

priceFloat!

Price for the plan (0 for free trials).

multiLoginCountInt!

Concurrent device limit.

dailyBandwidthString

Daily data allowance.

downloadUploadString

Speed limits.


Registration Flow

Free Trial

No-cost introductory plans.

Basic Plans

Entry-level paid options.

Premium Plans

Full-featured subscriptions.

Custom Plans

Special registration offers.


Use Cases

Signup Page

Display plan options for new users.

Landing Pages

Show available plans to visitors.

Mobile Apps

Plan selection in app registration.

Marketing

Dynamic pricing displays.



Registration-Only Plans

Not all subscription plans are available for registration. Admins can configure which plans appear during signup, allowing for curated onboarding experiences.

Implement User Signup

Use these groups to build your registration flow.

Signup API