Plugin Subscription Plans

Get all plugin subscription plans

GET

http://localhost:3000/api/plugin-plans

curl -X GET 'http://localhost:3000/api/plugin-plans'

const response = await fetch('http://localhost:3000/api/plugin-plans', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('http://localhost:3000/api/plugin-plans')
print(response.text)

200

[
  {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "name": "string",
    "description": "string",
    "type": "free",
    "price": 0,
    "currency": "string",
    "billingPeriod": "daily",
    "features": [
      "string"
    ],
    "limitations": {},
    "isPopular": true,
    "isRecommended": true,
    "trialDays": 0,
    "setupFee": 0,
    "discountPercentage": 0,
    "metadata": "string",
    "sortOrder": 0,
    "pluginId": "string",
    "createdById": "string",
    "subscriptions": [
      "string"
    ]
  }
]

Parameters

pluginIdstringquery

Filter by plugin ID

typestringfreetrialbasicpremiumenterprisecustomquery

Filter by plan type

billingPeriodstringdailyweeklymonthlyquarterlyyearlyone-timequery

Billing period

isActivebooleanquery

Filter by active status

isPopularbooleanquery

Filter by popular status

isRecommendedbooleanquery

Filter by recommended status

minPricenumberquery

Minimum price filter

maxPricenumberquery

Maximum price filter

currencystringquery

Currency filter

hasTrialbooleanquery

Has trial filter

Response

200OKArray<PluginSubscriptionPlan_1>

Plugin subscription plans retrieved successfully

Response fields application/json

Array<PluginSubscriptionPlan_1>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

Whether the plan is active and available for purchase

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plan name

descriptionstring

Plan description

typestringfreetrialbasicpremiumenterprisecustomrequired

Subscription type/plan level

pricenumberrequired

Plan price

currencystringrequired

Currency code (e.g., USD, EUR)

billingPeriodstringdailyweeklymonthlyquarterlyyearlyone-timerequired

Billing period

featuresArray<string>required

Plan features list

limitationsobject

Plan limitations and quotas

isPopularboolean

Whether this plan is marked as popular

isRecommendedboolean

Whether this plan is recommended

trialDaysnumber

Trial period duration in days

setupFeenumber

Setup fee for the plan

discountPercentagenumber

Discount percentage for the plan

metadatastring

Plan metadata (JSON string)

sortOrdernumber

Sort order for displaying plans

pluginIdstringrequired

Plugin ID

createdByIdstring

User who created this plan

subscriptionsArray<string>

Subscriptions using this plan

Stack Overflow Website Demo