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

Shorten User Subscription

cURL

curl --request PUT \
  --url https://codecombat.com/api/users/{handle}/shorten-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}/shorten-subscription`
json = { ends: new Date().toISOString() }
request.put({ url, json, auth }, (err, res) => {
  console.log(res.body.subscription.active) // false
})

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

oAuthIdentities · UserResponseOAuthIdentitiesItem · object[] | null

Show child attributes

subscription · UserResponseSubscription · object

Show child attributes

license · UserResponseLicense · object

Show child attributes