/api/user/subscriptions/published-plan (GET)
await global.api.user.subscriptions.PublishedPlan.get(req) Located in Stripe Subscriptions module API
Returns object
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|---|
invalid querystring planid | |
invalid-planid | missing querystring planid |
invalid-plan | ineligible querystring plan is not published |
NodeJS source (edit on github)
If you see a problem with the source submit a pull request on Github.
const stripeCache = require('../../../../stripe-cache.js')
module.exports = {
auth: false,
get: async (req) => {
if (!req.query || !req.query.planid) {
throw new Error('invalid-planid')
}
let plan
try {
plan = await stripeCache.retrieve(req.query.planid, 'plans', req.stripeKey)
} catch (error) {
}
if (!plan) {
throw new Error('invalid-planid')
}
if (!plan.metadata.published) {
throw new Error('invalid-plan')
}
return plan
}
}
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 TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/subscriptions/published-plan', () => {
describe('exceptions', () => {
describe('invalid-planid', () => {
it('missing querystring planid', async () => {
const req = TestHelper.createRequest('/api/user/subscriptions/published-plan')
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-planid')
})
it('invalid querystring planid', async () => {
const req = TestHelper.createRequest('/api/user/subscriptions/published-plan?planid=invalid')
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-planid')
})
})
describe('invalid-plan', () => {
it('ineligible querystring plan is not published', async () => {
const administrator = await TestStripeAccounts.createOwnerWithNotPublishedPlan()
const user = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/subscriptions/published-plan?planid=${administrator.plan.id}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-plan')
})
})
})
describe('returns', () => {
it('object', async () => {
const administrator = await TestStripeAccounts.createOwnerWithPlan()
const user = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/subscriptions/published-plan?planid=${administrator.plan.id}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const plan = await req.get()
assert.strictEqual(plan.id, administrator.plan.id)
})
})
})