Reset Subscription (Current Group) API

Reset user subscription to default group values while maintaining current group assignment

Admin

Reset Subscription API

Reset a user's subscription to the default group settings while keeping them in their current group. Restore standard plan parameters.

Full Reset

Restore default settings.

Keep Group

Same plan, fresh start.

New Duration

Full plan period restart.


Endpoint Overview

MUTATION/graphql

Reset a user's subscription to the default values defined by their current group. This restores all settings including duration, bandwidth, and login limits to group defaults.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

usernameString!Required

The username of the user whose subscription should be reset.


GraphQL Mutation

mutation resetUserSubscriptionWithCurrentGroup($username: String!) {
  resetUserSubscriptionWithCurrentGroup(username: $username) {
    duration
    multiLoginCount
    expiresAt
    createdAt
    updatedAt
    dailyBandwidth
    downloadUpload
  }
}

Variables:

{
  "username": "johndoe"
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation resetUserSubscriptionWithCurrentGroup($username: String!) { resetUserSubscriptionWithCurrentGroup(username: $username) { duration expiresAt multiLoginCount dailyBandwidth } }",
    "variables": {
      "username": "johndoe"
    }
  }'

Response

200Subscription Reset Successfully
{
  "data": {
    "resetUserSubscriptionWithCurrentGroup": {
      "duration": 30,
      "multiLoginCount": 3,
      "expiresAt": "2024-03-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-02-14T08:00:00Z",
      "dailyBandwidth": "10GB",
      "downloadUpload": "100Mbps"
    }
  }
}
400User Not Found
{
  "errors": [
    {
      "message": "User with username 'johndoe' not found",
      "path": ["resetUserSubscriptionWithCurrentGroup"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}
400No Active Subscription
{
  "errors": [
    {
      "message": "User has no active subscription to reset",
      "path": ["resetUserSubscriptionWithCurrentGroup"],
      "extensions": {
        "code": "NO_SUBSCRIPTION"
      }
    }
  ],
  "data": null
}

What Gets Reset

Duration

Full subscription period restarts.

Login Count

Returns to group default sessions.

Bandwidth

Daily limit restored to default.

Speed Limits

Download/upload reset to plan speed.


When to Reset

Fresh Start

User wants to restart subscription.

Corrupted Data

Fix incorrect subscription values.

Support Resolution

Resolve subscription issues.

Post-Modification

Undo custom changes made earlier.


Best Practices

Confirm Action

Verify reset is requested/needed.

Document Reason

Log why reset was performed.

Notify User

Inform user of subscription reset.

Review Changes

Verify new values after reset.



Full Reset

This operation resets ALL subscription parameters to group defaults, not just the expiration date. Any custom modifications will be lost.

Need a Different Plan?

If you want to reset with a different group, use the Reset with New Group endpoint.

Reset with New Group