Users

Shorten User Subscription

PUT
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.

Path parameters

handlestringRequired

The document’s _id or slug.

Request

This endpoint expects an object.
ends
stringRequired

Response

This endpoint returns an object
_id
stringOptional
email
stringOptional
name
stringOptional
slug
stringOptional
role
stringOptional
Usually either 'teacher' or 'student'
stats
objectOptional
oAuthIdentities
list of objectsOptional
subscription
objectOptional
license
objectOptional
PUT
1curl -X PUT https://codecombat.com/api/users/:handle/shorten-subscription \
2 -H "Content-Type: application/json" \
3 -u "<username>:<password>" \
4 -d '{
5 "ends": "string"
6}'
200Updated
1{
2 "_id": "string",
3 "email": "string",
4 "name": "string",
5 "slug": "string",
6 "role": "string",
7 "stats": {
8 "gamesCompleted": 1,
9 "concepts": {
10 "string": 1
11 },
12 "playTime": 1
13 },
14 "oAuthIdentities": [
15 {
16 "provider": "string",
17 "id": "string"
18 }
19 ],
20 "subscription": {
21 "ends": "string",
22 "active": true
23 },
24 "license": {
25 "ends": "string",
26 "active": true
27 }
28}