/api/administrator/subscriptions/payouts (GET)
await global.api.administrator.subscriptions.Payouts.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 payoutids
if (req.query.all) {
payoutids = await subscriptions.StorageList.listAll(`${req.appid}/payouts`)
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
payoutids = await subscriptions.StorageList.list(`${req.appid}/payouts`, offset, limit)
}
if (!payoutids || !payoutids.length) {
return null
}
const items = []
for (const payoutid of payoutids) {
req.query.payoutid = payoutid
const payout = await global.api.administrator.subscriptions.Payout.get(req)
items.push(payout)
}
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/payouts', function () {
if (!process.env.DISABLE_PAYOUT_TESTS) {
this.timeout(60 * 60 * 1000)
const cachedResponses = {}
const cachedPayouts = []
after(TestHelper.deleteOldWebhooks)
before(async () => {
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
await TestHelper.setupWebhook()
const administrator = await TestHelper.createOwner()
for (let i = 0, len = global.pageSize + 2; i < len; i++) {
await TestHelper.createPayout(administrator)
cachedPayouts.unshift(administrator.payout.id)
}
const req1 = TestHelper.createRequest('/api/administrator/subscriptions/payouts?offset=1')
req1.account = administrator.account
req1.session = administrator.session
cachedResponses.offset = await req1.get()
const req2 = TestHelper.createRequest('/api/administrator/subscriptions/payouts?limit=1')
req2.account = administrator.account
req2.session = administrator.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest('/api/administrator/subscriptions/payouts?all=true')
req3.account = administrator.account
req3.session = administrator.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest('/api/administrator/subscriptions/payouts')
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 payoutsNow = cachedResponses.offset
for (let i = 0, len = payoutsNow.length; i < len; i++) {
assert.strictEqual(payoutsNow[i].id, cachedPayouts[i + offset])
}
})
it('optional querystring limit (integer)', async () => {
const limit = 1
const payoutsNow = cachedResponses.limit
assert.strictEqual(payoutsNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const payouts = cachedResponses.all
assert.strictEqual(payouts.length, cachedPayouts.length)
})
})
describe('returns', () => {
it('array', async () => {
const payouts = cachedResponses.returns
assert.strictEqual(payouts.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
global.pageSize = 3
const payouts = cachedResponses.pageSize
assert.strictEqual(payouts.length, global.pageSize)
})
})
}
})