Skip to main content
POST
/
media
/
subscriptions
PlexGO
package main

import(
	"context"
	"github.com/LukeHagar/plexgo/models/components"
	"github.com/LukeHagar/plexgo"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Subscriptions.CreateSubscription(ctx, operations.CreateSubscriptionRequest{
        TargetLibrarySectionID: plexgo.Pointer[int64](1),
        TargetSectionLocationID: plexgo.Pointer[int64](3),
        Type: plexgo.Pointer[int64](2),
        Hints: &operations.Hints{},
        Prefs: &operations.CreateSubscriptionQueryParamPrefs{},
        Params: &operations.Params{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
{
  "MediaContainer": {
    "identifier": "<string>",
    "offset": 123,
    "size": 123,
    "totalSize": 123,
    "MediaSubscription": [
      {
        "title": "<string>",
        "type": 123,
        "airingsType": "New Airings Only",
        "createdAt": 123,
        "Directory": {},
        "durationTotal": 123,
        "key": "<string>",
        "librarySectionTitle": "<string>",
        "locationPath": "<string>",
        "MediaGrabOperation": [
          {
            "currentSize": 123,
            "grabberIdentifier": "<string>",
            "grabberProtocol": "<string>",
            "id": "<string>",
            "key": "<string>",
            "mediaIndex": 123,
            "mediaSubscriptionID": 123,
            "Metadata": {
              "title": "<any>",
              "type": "<any>",
              "absoluteIndex": 123,
              "addedAt": 123,
              "art": "<any>",
              "audienceRating": 5,
              "audienceRatingImage": "<any>",
              "Autotag": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "banner": "<any>",
              "chapterSource": "<any>",
              "composite": "<any>",
              "contentRating": "<any>",
              "Country": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "Director": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "duration": 123,
              "Filter": [
                {
                  "title": "<string>",
                  "type": "<string>",
                  "art": "<string>",
                  "content": true,
                  "filter": "<string>",
                  "hasPrefs": true,
                  "hasStoreServices": true,
                  "hubKey": "<string>",
                  "identifier": "<string>",
                  "key": "<string>",
                  "lastAccessedAt": 123,
                  "Pivot": [
                    "<any>"
                  ],
                  "share": 123,
                  "thumb": "<string>",
                  "titleBar": "<string>",
                  "filterType": "<string>"
                }
              ],
              "Genre": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "grandparentArt": "<string>",
              "grandparentHero": "<string>",
              "grandparentKey": "<string>",
              "grandparentRatingKey": "<string>",
              "grandparentTheme": "<string>",
              "grandparentThumb": "<string>",
              "grandparentTitle": "<string>",
              "Guid": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "hero": "<any>",
              "Image": [
                {
                  "type": "background",
                  "alt": "<string>",
                  "url": "<string>"
                }
              ],
              "index": 123,
              "key": "<any>",
              "lastViewedAt": 123,
              "leafCount": 123,
              "Media": [
                {
                  "aspectRatio": 2.35,
                  "audioChannels": 2,
                  "audioCodec": "<any>",
                  "audioProfile": "<any>",
                  "bitrate": 5612,
                  "container": "<any>",
                  "duration": 150192,
                  "has64bitOffsets": false,
                  "hasVoiceActivity": true,
                  "height": 544,
                  "id": 1,
                  "optimizedForStreaming": false,
                  "Part": [
                    {}
                  ],
                  "videoCodec": "<any>",
                  "videoFrameRate": "<any>",
                  "videoProfile": "<any>",
                  "videoResolution": "<any>",
                  "width": 1280
                }
              ],
              "originallyAvailableAt": "<any>",
              "originalTitle": "<any>",
              "parentHero": "<string>",
              "parentIndex": 123,
              "parentKey": "<string>",
              "parentRatingKey": "<string>",
              "parentThumb": "<string>",
              "parentTitle": "<string>",
              "primaryExtraKey": "<any>",
              "prompt": "<string>",
              "rating": 5,
              "Rating": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "ratingCount": 123,
              "ratingImage": "<any>",
              "ratingKey": "<any>",
              "Role": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "search": true,
              "secondary": true,
              "skipChildren": true,
              "skipParent": true,
              "Sort": [
                {
                  "title": "<string>",
                  "type": "<any>",
                  "art": "<any>",
                  "content": "<any>",
                  "filter": "<any>",
                  "hasPrefs": "<any>",
                  "hasStoreServices": "<any>",
                  "hubKey": "<any>",
                  "identifier": "<any>",
                  "key": "<string>",
                  "lastAccessedAt": "<any>",
                  "Pivot": "<any>",
                  "share": "<any>",
                  "thumb": "<any>",
                  "titleBar": "<any>",
                  "default": "asc",
                  "defaultDirection": "asc",
                  "descKey": "<string>",
                  "firstCharacterKey": "<string>"
                }
              ],
              "studio": "<any>",
              "subtype": "<any>",
              "summary": "<any>",
              "tagline": "<any>",
              "theme": "<any>",
              "thumb": "<any>",
              "titleSort": "<any>",
              "updatedAt": 123,
              "userRating": 5,
              "viewCount": 123,
              "viewedLeafCount": 123,
              "viewOffset": 123,
              "Writer": [
                {
                  "confidence": 123,
                  "context": "<string>",
                  "filter": "<any>",
                  "id": 123,
                  "ratingKey": "<string>",
                  "role": "<any>",
                  "tag": "<any>",
                  "tagKey": "<any>",
                  "tagType": 123,
                  "thumb": "<any>"
                }
              ],
              "year": 123
            },
            "percent": 123,
            "provider": "<string>",
            "status": "inactive"
          }
        ],
        "Playlist": {},
        "Setting": [
          {
            "type": "bool",
            "default": "<string>",
            "advanced": true,
            "enumValues": "<string>",
            "group": "<string>",
            "hidden": true,
            "id": "<string>",
            "label": "<string>",
            "summary": "<string>",
            "value": "<string>"
          }
        ],
        "storageTotal": 123,
        "targetLibrarySectionID": 123,
        "targetSectionLocationID": 123,
        "Video": {}
      }
    ]
  }
}

Authorizations

​
X-Plex-Token
string
header
required

The token which identifies the user accessing the PMS. This can be either:

  • A traditional access token obtained from plex.tv
  • A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

  • Short-lived tokens (7 days expiration)
  • Public-key cryptography (ED25519)
  • Better clock synchronization
  • Individual device revocation capability

Headers

​
accepts
enum<string>
default:application/xml

Indicates the client accepts the indicated media types

Available options:
application/json,
application/xml
​
X-Plex-Client-Identifier
string
required

An opaque identifier unique to the client

Example:

"abc123"

​
X-Plex-Product
string

The name of the client product

Example:

"Plex for Roku"

​
X-Plex-Version
string

The version of the client application

Example:

"2.4.1"

​
X-Plex-Platform
string

The platform of the client

Example:

"Roku"

​
X-Plex-Platform-Version
string

The version of the platform

Example:

"4.3 build 1057"

​
X-Plex-Device
string

A relatively friendly name for the client device

Example:

"Roku 3"

​
X-Plex-Model
string

A potentially less friendly identifier for the device model

Example:

"4200X"

​
X-Plex-Device-Vendor
string

The device vendor

Example:

"Roku"

​
X-Plex-Device-Name
string

A friendly name for the client

Example:

"Living Room TV"

​
X-Plex-Marketplace
string

The marketplace on which the client application is distributed

Example:

"googlePlay"

Query Parameters

​
targetLibrarySectionID
integer

The library section into which we'll grab the media. Not actually required when the subscription is to a playlist.

​
targetSectionLocationID
integer

The section location into which to grab.

​
type
integer

The type of the thing we're subscribing too (e.g. show, season).

​
hints
object

Hints describing what we're looking for. Note: The hint ratingKey is required for downloading from a PMS remote.

​
prefs
object

Subscription preferences.

​
params
object

Subscription parameters.

  • mediaProviderID: Required for downloads to indicate which MP the subscription will download into
  • source: Required for downloads to indicate the source of the downloaded content.

Response

OK

​
MediaContainer
object

MediaContainer is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable. Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination) The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the parentTitle attribute may appear on the MediaContainer rather than being repeated on each track.