Stripe Subscriptions module API explorer

/api/user/subscriptions/published-plans-count (GET)

await global.api.user.subscriptions.PublishedPlansCount.get(req)

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}/published/plans`, req.stripeKey)
  }
}

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/user/subscriptions/published-plans-count', () => {
  describe('returns', () => {
    it('integer', async () => {
      const administrator = await TestHelper.createOwner()
      const product = await TestHelper.createProduct(administrator, {
        published: 'true'
      })
      await TestHelper.createPlan(administrator, {
        productid: product.id,
        usage_type: 'licensed',
        published: 'true',
        amount: 100000,
        trial_period_days: 0
      })
      await TestHelper.createPlan(administrator, {
        productid: product.id,
        usage_type: 'licensed',
        published: 'true'
      })
      const user = await TestHelper.createUser()
      await TestHelper.createCustomer(user, {
        email: user.profile.contactEmail,
        description: user.profile.firstName
      })
      const req = TestHelper.createRequest('/api/user/subscriptions/published-plans-count')
      req.account = user.account
      req.session = user.session
      req.filename = __filename
      req.saveResponse = true
      const result = await req.get()
      assert.strictEqual(result, global.pageSize)
    })
  })
})