/api/administrator/subscriptions/customers (GET)
await global.api.administrator.subscriptions.Customers.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 customerids
if (req.query.all) {
customerids = await subscriptions.StorageList.listAll(`${req.appid}/customers`)
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
customerids = await subscriptions.StorageList.list(`${req.appid}/customers`, offset, limit)
}
if (!customerids || !customerids.length) {
return null
}
const items = []
for (const customerid of customerids) {
req.query.customerid = customerid
const item = await global.api.administrator.subscriptions.Customer.get(req)
items.push(item)
}
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/customers', function () {
this.timeout(60 * 60 * 1000)
const cachedResponses = {}
const cachedCustomers = []
before(async () => {
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const administrator = await TestHelper.createOwner()
for (let i = 0, len = global.pageSize + 2; i < len; i++) {
const user = await TestHelper.createUser()
await TestHelper.createCustomer(user, {
email: user.profile.contactEmail,
description: user.profile.firstName
})
cachedCustomers.unshift(user.customer.id)
}
const offset = 1
const limit = 1
const req1 = TestHelper.createRequest(`/api/administrator/subscriptions/customers?offset=${offset}`)
req1.account = administrator.account
req1.session = administrator.session
cachedResponses.offset = await req1.get()
const req2 = TestHelper.createRequest(`/api/administrator/subscriptions/customers?limit=${limit}`)
req2.account = administrator.account
req2.session = administrator.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest('/api/administrator/subscriptions/customers?all=true')
req3.account = administrator.account
req3.session = administrator.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest('/api/administrator/subscriptions/customers')
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 customersNow = cachedResponses.offset
for (let i = 0, len = customersNow.length; i < len; i++) {
assert.strictEqual(customersNow[i].id, cachedCustomers[i + offset])
}
})
it('optional querystring limit (integer)', async () => {
const limit = 1
const customersNow = cachedResponses.limit
assert.strictEqual(customersNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const customers = cachedResponses.all
assert.strictEqual(customers.length, cachedCustomers.length)
})
})
describe('returns', () => {
it('array', async () => {
const customers = cachedResponses.returns
assert.strictEqual(customers.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
global.pageSize = 3
const customers = cachedResponses.pageSize
assert.strictEqual(customers.length, global.pageSize)
})
})
})