Users
Put Subscription
Grants a user premium access to the “Home” version up to a certain time.
PUT
/
users
/
{handle}
/
subscription
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
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
handle
string
requiredThe document's _id
or slug
.
Body
application/json
ends
string
requiredResponse
200 - application/json
_id
string | null
email
string | null
name
string | null
slug
string | null
role
string | null
Usually either 'teacher' or 'student'
stats
object | null
oAuthIdentities
object[] | null
subscription
object | null
license
object | null