/api/administrator/subscriptions/customers-count (GET)
await global.api.administrator.subscriptions.CustomersCount.get(req) Located in Stripe Subscriptions module API
Returns integer
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|
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) => {
return subscriptions.StorageList.count(`${req.appid}/customers`)
}
}
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')
describe('/api/administrator/subscriptions/customers-count', () => {
describe('returns', () => {
it('integer', async () => {
const administrator = await TestHelper.createOwner()
const user1 = await TestHelper.createUser()
await TestHelper.createCustomer(user1, {
email: user1.profile.contactEmail,
description: user1.profile.firstName
})
const user2 = await TestHelper.createUser()
await TestHelper.createCustomer(user2, {
email: user2.profile.contactEmail,
description: user2.profile.firstName
})
const req = TestHelper.createRequest('/api/administrator/subscriptions/customers-count')
req.account = administrator.account
req.session = administrator.session
req.filename = __filename
req.saveResponse = true
const result = await req.get()
assert.strictEqual(result, global.pageSize)
})
})
})