/api/user/subscriptions/subscriptions (GET)
await global.api.user.subscriptions.Subscriptions.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 |
---|---|
invalid querystring accountid | |
invalid-accountid | missing querystring accountid |
invalid-account | ineligible accessing account |
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) => {
if (!req.query || !req.query.accountid) {
throw new Error('invalid-accountid')
}
const account = await global.api.user.Account.get(req)
if (!account) {
throw new Error('invalid-account')
}
let index
if (req.query.customerid) {
const customer = await global.api.user.subscriptions.Customer.get(req)
if (!customer) {
throw new Error('invalid-customerid')
}
index = `${req.appid}/customer/subscriptions/${req.query.customerid}`
} else {
index = `${req.appid}/account/subscriptions/${req.query.accountid}`
}
let subscriptionids
if (req.query.all) {
subscriptionids = await subscriptions.StorageList.listAll(index)
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
subscriptionids = await subscriptions.StorageList.list(index, offset, limit)
}
if (!subscriptionids || !subscriptionids.length) {
return null
}
const items = []
for (const subscriptionid of subscriptionids) {
req.query.subscriptionid = subscriptionid
const subscription = await global.api.user.subscriptions.Subscription.get(req)
items.push(subscription)
}
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 TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
const DashboardTestHelper = require('@userdashboard/dashboard/test-helper.js')
describe('/api/user/subscriptions/subscriptions', function () {
this.timeout(60 * 60 * 1000)
const cachedResponses = {}
const cachedSubscriptions = []
after(TestHelper.deleteOldWebhooks)
before(async () => {
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
await TestHelper.setupWebhook()
const administrator = await TestHelper.createOwner()
await TestHelper.createProduct(administrator, {
published: 'true'
})
const user = await TestStripeAccounts.createUserWithPaymentMethod()
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: '10000',
interval: 'day'
})
await TestHelper.createSubscription(user, administrator.plan.id)
cachedSubscriptions.unshift(user.subscription.id)
await TestHelper.deleteOldWebhooks()
await TestHelper.setupWebhook()
}
const req1 = TestHelper.createRequest(`/api/user/subscriptions/subscriptions?accountid=${user.account.accountid}&offset=1`)
req1.account = user.account
req1.session = user.session
cachedResponses.offset = await req1.get()
const req2 = TestHelper.createRequest(`/api/user/subscriptions/subscriptions?accountid=${user.account.accountid}&limit=1`)
req2.account = user.account
req2.session = user.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest(`/api/user/subscriptions/subscriptions?accountid=${user.account.accountid}&all=true`)
req3.account = user.account
req3.session = user.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest(`/api/user/subscriptions/subscriptions?accountid=${user.account.accountid}`)
req4.account = user.account
req4.session = user.session
req4.filename = __filename
req4.saveResponse = true
cachedResponses.returns = await req4.get()
global.pageSize = 3
cachedResponses.pageSize = await req4.get()
})
describe('exceptions', () => {
describe('invalid-accountid', () => {
it('missing querystring accountid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/subscriptions/subscriptions')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
it('invalid querystring accountid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/subscriptions/subscriptions?accountid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const user = await TestHelper.createUser()
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/subscriptions/subscriptions?accountid=${user.account.accountid}`)
req.account = user2.account
req.session = user2.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('receives', () => {
it('optional querystring offset (integer)', async () => {
const offset = 1
const subscriptionsNow = cachedResponses.offset
for (let i = 0, len = global.pageSize; i < len; i++) {
assert.strictEqual(subscriptionsNow[i].id, cachedSubscriptions[offset + i])
}
})
it('optional querystring limit (integer)', async () => {
const limit = 1
const subscriptionsNow = cachedResponses.limit
assert.strictEqual(subscriptionsNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const subscriptionsNow = cachedResponses.all
assert.strictEqual(subscriptionsNow.length, cachedSubscriptions.length)
})
})
describe('returns', () => {
it('array', async () => {
const subscriptionsNow = cachedResponses.returns
assert.strictEqual(subscriptionsNow.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
global.pageSize = 3
const subscriptionsNow = cachedResponses.pageSize
assert.strictEqual(subscriptionsNow.length, global.pageSize)
})
})
})