Subscriptions

GET

Retrieves all subscription tiers.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/subscriptions'

200

500

200

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

Subscription tiers retrieved successfully

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

get

Query parameters

teamIdstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/subscriptions/me?teamId=text'

200

400

403

404

200

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

Subscription details retrieved successfully

POST

Creates a new subscription tier.

post

Body

namestring | nullablerequired

Example: Basic

descriptionstring | nullablerequired

Example: Basic subscription tier

featuresobject[] | nullablerequired

pricenumber | nullablerequired

Example: 1000

prioritynumber | nullablerequired

Example: 1

usersLimitnumber | nullablerequired

Example: 10

teamsLimitnumber | nullablerequired

Example: 5

isPopularboolean | nullablerequired

Example: true

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/subscriptions' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Basic",
    "description": "Basic subscription tier",
    "features": [
      {
        "name": "Feature 1"
      }
    ],
    "price": 1000,
    "priority": 1,
    "usersLimit": 10,
    "teamsLimit": 5,
    "isPopular": true
  }'

201

400

500

201

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

Subscription tier created successfully

Registers a new subscription for the team.

post

Body

priceIdstringrequired

Example: price_1F7X2Y2eZvKYlo2C0q0G5Z2e

quantitynumberrequired

Example: 1

teamIdstring | nullablerequired

Example: team_id

isTeamCreationbooleanrequired

Example: true

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/subscriptions/register' \
  --header 'Content-Type: application/json' \
  --data '{
    "priceId": "price_1F7X2Y2eZvKYlo2C0q0G5Z2e",
    "quantity": 1,
    "teamId": "team_id",
    "isTeamCreation": true
  }'

200

400

403

500

200

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

Subscription registered successfully

Cancels the subscription period for the team.

post

Body

subscriptionstringoptional

Example: sub_1F7X2Y2eZvKYlo2C0q0G5Z2e

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/subscriptions/cancel' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscription": "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"
  }'

200

400

403

500

200

{
  "message": "Subscription period cancelled successfully",
  "description": "The subscription period has been cancelled successfully."
}

Subscription period cancelled successfully

Cancels the subscription immediately for the team.

post

Body

subscriptionstringoptional

Example: sub_1F7X2Y2eZvKYlo2C0q0G5Z2e

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/subscriptions/cancel-immediately' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscription": "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"
  }'

200

400

403

500

200

{
  "message": "Subscription cancelled successfully",
  "description": "The subscription has been cancelled successfully."
}

Subscription cancelled successfully

Renews the subscription period for the team.

post

Body

subscriptionstringoptional

Example: sub_1F7X2Y2eZvKYlo2C0q0G5Z2e

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/subscriptions/renew' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscription": "sub_1F7X2Y2eZvKYlo2C0q0G5Z2e"
  }'

200

400

403

500

200

{
  "message": "Subscription period renewed successfully",
  "description": "The subscription period has been renewed successfully."
}

Subscription period renewed successfully

PUT

Updates a subscription tier.

put

Body

namestring | nullablerequired

Example: Basic

descriptionstring | nullablerequired

Example: Basic subscription tier

featuresobject[] | nullablerequired

pricenumber | nullablerequired

Example: 1000

prioritynumber | nullablerequired

Example: 1

usersLimitnumber | nullablerequired

Example: 10

teamsLimitnumber | nullablerequired

Example: 5

isPopularboolean | nullablerequired

Example: true

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/subscriptions' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Basic",
    "description": "Basic subscription tier",
    "features": [
      {
        "name": "Feature 1"
      }
    ],
    "price": 1000,
    "priority": 1,
    "usersLimit": 10,
    "teamsLimit": 5,
    "isPopular": true
  }'

200

400

500

200

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

Subscription tier updated successfully

DELETE

Deletes a subscription tier by its ID.

delete

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/subscriptions/{id}'

200

400

500

200

{
  "message": "Subscription tier deleted successfully",
  "description": "The subscription tier has been deleted successfully."
}

Subscription tier deleted successfully