Subscriptions

GET

Retrieves all subscription tiers.

GET/subscriptions

Response

200500

Subscription tiers retrieved successfully

Body

application/json

idnumber

Example: 1

titlestring

Example: "Basic"

pricenumber

Example: 1000

prioritynumber

Example: 1

usersLimitnumber

Example: 10

teamsLimitnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "id": 1,
    "title": "Basic",
    "price": 1000,
    "priority": 1,
    "usersLimit": 10,
    "teamsLimit": 5
  }
]

Retrieves the subscription details for the authenticated user's team.

GET/subscriptions/me

Query parameters

Response

200400403404

Subscription details retrieved successfully

Body

application/json

teamIdstring

Example: "team_id"

subscriptionIdstring

Example: "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"

endDatestring (date-time)

Example: "2023-01-01T00:00:00Z"

pricenumber

Example: 1000

statusstring

Example: "active"

tierstring

Example: "Basic"

prioritynumber

Example: 1

usersLimitnumber

Example: 10

teamsLimitnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/me?teamId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "teamId": "team_id",
  "subscriptionId": "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e",
  "endDate": "2023-01-01T00:00:00Z",
  "price": 1000,
  "status": "active",
  "tier": "Basic",
  "priority": 1,
  "usersLimit": 10,
  "teamsLimit": 5
}

POST

Creates a new subscription tier.

POST/subscriptions

Body

application/json

Subscription tier creation data

name*nullable string

Name of the subscription tier

Example: "Basic"

description*nullable string

Description of the subscription tier

Example: "Basic subscription tier"

features*nullable array of object

Features of the subscription tier

price*nullable number

Price of the subscription tier

Example: 1000

priority*nullable number

Priority of the subscription tier

Example: 1

usersLimit*nullable number

User limit of the subscription tier

Example: 10

teamsLimit*nullable number

Team limit of the subscription tier

Example: 5

isPopular*nullable boolean

Indicates if the subscription tier is popular

Example: true

Response

201400500

Subscription tier created successfully

Body

application/json

idnumber

Example: 1

titlestring

Example: "Basic"

pricenumber

Example: 1000

prioritynumber

Example: 1

usersLimitnumber

Example: 10

teamsLimitnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Basic",
      "description": "Basic subscription tier",
      "features": [
        {}
      ],
      "price": 1000,
      "priority": 1,
      "usersLimit": 10,
      "teamsLimit": 5,
      "isPopular": true
    }),
});
const data = await response.json();

Response

201400500

{
  "id": 1,
  "title": "Basic",
  "price": 1000,
  "priority": 1,
  "usersLimit": 10,
  "teamsLimit": 5
}

Registers a new subscription for the team.

POST/subscriptions/register

Body

application/json

Subscription registration data

priceId*string

Price ID for the subscription

Example: "price_1F7X2Y2eZvKYlo2C0q0G5Z2e"

quantity*number

Quantity for the subscription

Example: 1

teamId*nullable string

Team ID for the subscription

Example: "team_id"

isTeamCreation*boolean

Indicates if the subscription is for team creation

Example: true

Response

200400403500

Subscription registered successfully

Body

application/json

redirectboolean

Example: true

urlstring

Example: "https://checkout.stripe.com/pay/cs_test_a1b2c3d4e5f6g7h8i9j0"

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "priceId": "price_1F7X2Y2eZvKYlo2C0q0G5Z2e",
      "quantity": 1,
      "teamId": "team_id",
      "isTeamCreation": true
    }),
});
const data = await response.json();

Response

200400403500

{
  "redirect": true,
  "url": "https://checkout.stripe.com/pay/cs_test_a1b2c3d4e5f6g7h8i9j0"
}

Cancels the subscription period for the team.

POST/subscriptions/cancel

Body

application/json

Subscription cancellation data

subscriptionstring

Example: "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"

Response

200400403500

Subscription period cancelled successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/cancel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Subscription period cancelled successfully",
  "description": "<p>The subscription period has been cancelled successfully.</p>",
  "__$markdownParsed": true
}

Cancels the subscription immediately for the team.

POST/subscriptions/cancel-immediately

Body

application/json

Subscription cancellation data

subscriptionstring

Example: "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"

Response

200400403500

Subscription cancelled successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/cancel-immediately', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Subscription cancelled successfully",
  "description": "<p>The subscription has been cancelled successfully.</p>",
  "__$markdownParsed": true
}

Renews the subscription period for the team.

POST/subscriptions/renew

Body

application/json

Subscription renewal data

subscriptionstring

Example: "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"

Response

200400403500

Subscription period renewed successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/renew', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Subscription period renewed successfully",
  "description": "<p>The subscription period has been renewed successfully.</p>",
  "__$markdownParsed": true
}

PUT

Updates a subscription tier.

PUT/subscriptions

Body

application/json

Subscription tier update data

name*nullable string

Name of the subscription tier

Example: "Basic"

description*nullable string

Description of the subscription tier

Example: "Basic subscription tier"

features*nullable array of object

Features of the subscription tier

price*nullable number

Price of the subscription tier

Example: 1000

priority*nullable number

Priority of the subscription tier

Example: 1

usersLimit*nullable number

User limit of the subscription tier

Example: 10

teamsLimit*nullable number

Team limit of the subscription tier

Example: 5

isPopular*nullable boolean

Indicates if the subscription tier is popular

Example: true

Response

200400500

Subscription tier updated successfully

Body

application/json

idnumber

Example: 1

titlestring

Example: "Basic"

pricenumber

Example: 1000

prioritynumber

Example: 1

usersLimitnumber

Example: 10

teamsLimitnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Basic",
      "description": "Basic subscription tier",
      "features": [
        {}
      ],
      "price": 1000,
      "priority": 1,
      "usersLimit": 10,
      "teamsLimit": 5,
      "isPopular": true
    }),
});
const data = await response.json();

Response

200400500

{
  "id": 1,
  "title": "Basic",
  "price": 1000,
  "priority": 1,
  "usersLimit": 10,
  "teamsLimit": 5
}

DELETE

Deletes a subscription tier by its ID.

DELETE/subscriptions/{id}

Path parameters

id*string

Response

200400500

Subscription tier deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/subscriptions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "message": "Subscription tier deleted successfully",
  "description": "<p>The subscription tier has been deleted successfully.</p>",
  "__$markdownParsed": true
}