Users
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.
PUT
/
users
/
{handle}
/
shorten-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
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