Put Subscription

Grants a user premium access to the “Home” version up to a certain time.

PUT /users/{handle}/subscription

Try it

Put Subscription

cURL

curl --request PUT \
  --url https://codecombat.com/api/users/{handle}/subscription \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ends": "<string>"
}
'

200

{
  "_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "role": "<string>",
  "stats": {
    "gamesCompleted": 123,
    "concepts": {},
    "playTime": 123
  },
  "oAuthIdentities": [
    {
      "provider": "<string>",
      "id": "<string>"
    }
  ],
  "subscription": {
    "ends": "<string>",
    "active": true
  },
  "license": {
    "ends": "<string>",
    "active": true
  }
}

url = `https://codecombat.com/api/users/${userID}/subscription`
json = { ends: new Date('2017-01-01').toISOString() }
request.put({ url, json, auth }, (err, res) => {
  console.log(res.body.subscription) // { ends: '2017-01-01T00:00:00.000Z', active: true }
})

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

handle · string · required

The document's _id or slug.

Body

application/json

ends · string · required

Response

200 - application/json

The affected user

Subset of properties listed here

_id · string | null

email · string | null

name · string | null

slug · string | null

role · string | null

Usually either 'teacher' or 'student'

stats · UserResponseStats · object

Show child attributes

stats. gamesCompleted · number<double> | null

stats. concepts · object

Show child attributes

stats.concepts. {key} · number<double>

stats. playTime · number<double> | null

Included only when specifically requested on the endpoint

oAuthIdentities · UserResponseOAuthIdentitiesItem · object[] | null

Show child attributes

oAuthIdentities. provider · string | null

oAuthIdentities. id · string | null

subscription · UserResponseSubscription · object

Show child attributes

subscription. ends · string | null

subscription. active · boolean | null

license · UserResponseLicense · object

Show child attributes

license. ends · string | null

license. active · boolean | null