/api/administrator/subscriptions/plans (GET)
await global.api.administrator.subscriptions.Plans.get(req) Located in Stripe Subscriptions module API
Returns array
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|
Receives
API routes may receive parameters from the URL and POST supporting simple and multipart:
Field | Value | Required | Type |
---|---|---|---|
all | boolean | optional | URL |
limit | integer | optional | URL |
offset | integer | optional | URL |
NodeJS source (edit on github)
If you see a problem with the source submit a pull request on Github.
const subscriptions = require('../../../../../index.js')
module.exports = {
get: async (req) => {
req.query = req.query || {}
let planids
if (req.query.all) {
planids = await subscriptions.StorageList.listAll(`${req.appid}/plans`)
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
planids = await subscriptions.StorageList.list(`${req.appid}/plans`, offset, limit)
}
if (!planids || !planids.length) {
return null
}
const items = []
for (const planid of planids) {
req.query.planid = planid
const plan = await global.api.administrator.subscriptions.Plan.get(req)
items.push(plan)
}
return items
}
}
Test source (edit on github)
Tests perform real HTTP requests against a running Dashboard server.
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const DashboardTestHelper = require('@userdashboard/dashboard/test-helper.js')
describe('/api/administrator/subscriptions/plans', function () {
this.timeout(60 * 60 * 1000)
const cachedResponses = {}
const cachedPlans = []
before(async () => {
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const administrator = await TestHelper.createOwner()
await TestHelper.createProduct(administrator, {
published: 'true'
})
for (let i = 0, len = global.pageSize + 2; i < len; i++) {
await TestHelper.createPlan(administrator, {
productid: administrator.product.id,
usage_type: 'licensed',
published: 'true',
trial_period_days: '0',
amount: '1000'
})
cachedPlans.unshift(administrator.plan.id)
}
const req1 = TestHelper.createRequest('/api/administrator/subscriptions/plans?offset=1')
req1.account = administrator.account
req1.session = administrator.session
cachedResponses.offset = await req1.get()
const req2 = TestHelper.createRequest('/api/administrator/subscriptions/plans?limit=1')
req2.account = administrator.account
req2.session = administrator.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest('/api/administrator/subscriptions/plans?all=true')
req3.account = administrator.account
req3.session = administrator.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest('/api/administrator/subscriptions/plans')
req4.account = administrator.account
req4.session = administrator.session
req4.filename = __filename
req4.saveResponse = true
cachedResponses.returns = await req4.get()
global.pageSize = 3
cachedResponses.pageSize = await req4.get()
})
describe('receives', () => {
it('optional querystring offset (integer)', async () => {
const offset = 1
const plansNow = cachedResponses.offset
for (let i = 0, len = global.pageSize; i < len; i++) {
assert.strictEqual(plansNow[i].id, cachedPlans[offset + i])
}
})
it('optional querystring limit (integer)', async () => {
const limit = 1
const plansNow = cachedResponses.limit
assert.strictEqual(plansNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const plansNow = cachedResponses.all
assert.strictEqual(plansNow.length, cachedPlans.length)
})
})
describe('returns', () => {
it('array', async () => {
const plansNow = cachedResponses.returns
assert.strictEqual(plansNow.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
global.pageSize = 3
const plansNow = cachedResponses.pageSize
assert.strictEqual(plansNow.length, global.pageSize)
})
})
})