Stripe Subscriptions module API explorer

/api/administrator/subscriptions/payouts-count (GET)

await global.api.administrator.subscriptions.PayoutsCount.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}/payouts`)
  }
}

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/payouts-count', () => {
  if (!process.env.DISABLE_PAYOUT_TESTS) {
    describe('returns', function () {
      this.timeout(60 * 60 * 1000)
      after(TestHelper.deleteOldWebhooks)
      before(TestHelper.setupWebhook)
      it('integer', async () => {
        const administrator = await TestHelper.createOwner()
        for (let i = 0, len = global.pageSize + 1; i < len; i++) {
          await TestHelper.createPayout(administrator)
        }
        const req = TestHelper.createRequest('/api/administrator/subscriptions/payouts-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 + 1)
      })
    })
  }
})