/api/user/subscriptions/subscriptions-count (GET)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.user.subscriptions.SubscriptionsCount.get(req)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-account | ineligible accessing account |
invalid-accountid | missing querystring accountid |
invalid querystring accountid |
NodeJS source (view on github)
const subscriptions = require('../../../../../index.js')
module.exports = {
get: async (req) => {
if (!req.query || !req.query.accountid) {
throw new Error('invalid-accountid')
}
const where = {
appid: req.appid || global.appid
}
if (req.query.customerid) {
const customer = await global.api.user.subscriptions.Customer.get(req)
if (!customer) {
throw new Error('invalid-customer')
}
where.customerid = req.query.customerid
} else if (req.query.accountid) {
const account = await global.api.user.Account.get(req)
if (!account) {
throw new Error('invalid-account')
}
where.accountid = req.query.accountid
}
return subscriptions.Storage.Subscription.count({
where
})
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/subscriptions/subscriptions-count', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
describe('exceptions', () => {
describe('invalid-accountid', () => {
it('missing querystring accountid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/subscriptions/subscriptions-count')
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-count?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-count?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('returns', () => {
it('integer', async () => {
const administrator = await TestStripeAccounts.createOwnerWithPrice()
const price1 = administrator.price
const price2 = await TestHelper.createPrice(administrator, {
productid: administrator.product.productid,
currency: 'usd',
unit_amount: 3000,
recurring_interval: 'month',
recurring_interval_count: '1',
recurring_usage_type: 'licensed',
active: 'true',
tax_behavior: 'inclusive'
})
const user = await TestStripeAccounts.createUserWithPaidSubscription(price1)
await TestStripeAccounts.createUserWithPaidSubscription(price2, user)
const req = TestHelper.createRequest(`/api/user/subscriptions/subscriptions-count?accountid=${user.account.accountid}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const result = await req.get()
assert.strictEqual(result, global.pageSize)
})
})
})