Shorten User Subscription

If the user already has a premium access up to a certain time, this shortens/revokes his/her premium access. If the ends is less than or equal to the current time, it revokes the subscription and sets the end date to be the current time, else it just shortens the subscription.

url = `https://codecombat.com/api/users/${userID}/shorten-subscription`
json = { ends: new Date().toISOString() }
request.put({ url, json, auth }, (err, res) => {
  console.log(res.body.subscription.active) // false
})

Authorizations

Authorization

string

headerrequired

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

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

object | null

Show child attributes

stats.gamesCompleted

number | null

stats.concepts

object | null

Show child attributes

stats.concepts.{key}

number

stats.playTime

number | null

Included only when specifically requested on the endpoint

oAuthIdentities

object[] | null

Show child attributes

oAuthIdentities.provider

string | null

oAuthIdentities.id

string | null

subscription

object | null

Show child attributes

subscription.ends

string | null

subscription.active

boolean | null

license

object | null

Show child attributes

license.ends

string | null

license.active

boolean | null