Edit Group API

Modify existing subscription group settings including pricing, duration, and feature limits

Plan Management

Edit Group API

Update subscription plan configurations. Modify pricing, duration, bandwidth limits, device allowances, and other plan features for existing groups.

Flexible Updates

Modify any plan attribute.

Price Changes

Update pricing for promotions or adjustments.

Feature Updates

Adjust limits and capabilities.


Endpoint Overview

MUTATION/graphql

Update an existing subscription group's attributes including name, price, duration, bandwidth limits, and device allowances.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

idInt!Required

The unique identifier of the group to update.

groupGroupEdit!Required

Object containing the fields to update.

nameString

Updated name for the plan.

descriptionString

Updated description.

priceString

New price for the plan.

durationInt

Updated duration in days.

dailyBandwidthString

Updated bandwidth limit.

multiLoginCountInt

Updated device connection limit.

downloadUploadString

Updated speed limits.


GraphQL Mutation

mutation editGroup($id: Int!, $group: GroupEdit!) {
  editGroup(id: $id, group: $group) {
    id
    name
    description
    price
    duration
    multiLoginCount
    dailyBandwidth
  }
}

Variables:

{
  "id": 15,
  "group": {
    "price": "7.99",
    "multiLoginCount": 7,
    "description": "Updated Pro plan with more devices"
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation editGroup($id: Int!, $group: GroupEdit!) { editGroup(id: $id, group: $group) { id name price multiLoginCount } }",
    "variables": {
      "id": 15,
      "group": {
        "price": "7.99",
        "multiLoginCount": 7
      }
    }
  }'

Response

200Group Updated Successfully
{
  "data": {
    "editGroup": {
      "id": "15",
      "name": "Pro Monthly",
      "description": "Updated Pro plan with more devices",
      "price": "7.99",
      "duration": 30,
      "multiLoginCount": 7,
      "dailyBandwidth": "unlimited"
    }
  }
}
400Group Not Found
{
  "errors": [
    {
      "message": "Group not found",
      "path": ["editGroup"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

Common Updates

Price Adjustments

Update pricing for promotions, sales, or market changes.

Feature Upgrades

Increase device limits or bandwidth for existing plans.

Description Updates

Improve marketing copy and feature descriptions.

Duration Changes

Modify plan duration for special offers.


Best Practices

Partial Updates

Only include fields that need to change.

Price Change Notice

Notify users before significant price increases.

Feature Parity

Ensure upgrades don't break existing user expectations.

Test First

Validate changes in staging environment.



Existing Subscriptions

Price changes typically affect new subscriptions only. Existing users usually keep their original pricing until renewal, depending on your business rules.

Review Current Settings

View the current group configuration before making changes to understand the impact.

Get Group API