/api/administrator/subscriptions/delete-subscription (DELETE)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.administrator.subscriptions.DeleteSubscription.delete(req)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-subscription | ineligible querystring subscription is not active |
invalid-subscriptionid | missing querystring subscriptionid |
invalid querystring subscriptionid |
NodeJS source (view on github)
const stripeCache = require('../../../../stripe-cache.js')
const subscriptions = require('../../../../../index.js')
module.exports = {
delete: async (req) => {
if (!req.query || !req.query.subscriptionid) {
throw new Error('invalid-subscriptionid')
}
const subscription = await global.api.administrator.subscriptions.Subscription.get(req)
if (!subscription) {
throw new Error('invalid-subscriptionid')
}
if ((subscription.stripeObject.status !== 'active' && subscription.stripeObject.status !== 'trialing') || subscription.stripeObject.cancel_at_period_end) {
throw new Error('invalid-subscription')
}
req.query.invoiceid = subscription.stripeObject.latest_invoice
const invoice = await global.api.administrator.subscriptions.Invoice.get(req)
let subscriptionNow
if (!invoice.amount_paid) {
subscriptionNow = await stripeCache.execute('subscriptions', 'del', req.query.subscriptionid, req.stripeKey)
} else {
const deleteOptions = {
prorate: true
}
subscriptionNow = await stripeCache.execute('subscriptions', 'del', req.query.subscriptionid, deleteOptions, req.stripeKey)
}
await subscriptions.Storage.Subscription.update({
stripeObject: subscriptionNow
}, {
where: {
subscriptionid: req.query.subscriptionid,
appid: req.appid || global.appid
}
})
return true
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
const DashboardTestHelper = require('@layeredapps/dashboard/test-helper.js')
describe('/api/administrator/subscriptions/delete-subscription', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
let cachedResponses
async function bundledData (retryNumber) {
if (retryNumber > 0) {
cachedResponses = {}
}
if (cachedResponses && cachedResponses.finished) {
return
}
cachedResponses = {}
await TestHelper.setupBefore()
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const administrator = await TestStripeAccounts.createOwnerWithPrice()
// mising and invalid id
const req = TestHelper.createRequest('/api/administrator/subscriptions/delete-subscription')
req.account = administrator.account
req.session = administrator.session
try {
await req.delete()
} catch (error) {
cachedResponses.missing = error.message
}
const req2 = TestHelper.createRequest('/api/administrator/subscriptions/delete-subscription?subscriptionid=invalid')
req2.account = administrator.account
req2.session = administrator.session
try {
await req2.delete()
} catch (error) {
cachedResponses.invalid = error.message
}
// invalid subscription
const user = await TestStripeAccounts.createUserWithPaidSubscription(administrator.price)
await TestHelper.cancelSubscription(user)
const req3 = TestHelper.createRequest(`/api/administrator/subscriptions/delete-subscription?subscriptionid=${user.subscription.subscriptionid}`)
req3.account = administrator.account
req3.session = administrator.session
req3.body = {
refund: 'credit'
}
try {
await req3.delete()
} catch (error) {
cachedResponses.invalidSubscription = error.message
}
// returns
await TestStripeAccounts.createUserWithPaidSubscription(administrator.price, user)
const req4 = TestHelper.createRequest(`/api/administrator/subscriptions/delete-subscription?subscriptionid=${user.subscription.subscriptionid}`)
req4.account = administrator.account
req4.session = administrator.session
req4.body = {
refund: 'refund'
}
req4.filename = __filename
req4.saveResponse = true
cachedResponses.returns = await req4.delete()
cachedResponses.finished = true
}
describe('exceptions', () => {
describe('invalid-subscriptionid', () => {
it('missing querystring subscriptionid', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.missing
assert.strictEqual(errorMessage, 'invalid-subscriptionid')
})
it('invalid querystring subscriptionid', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.invalid
assert.strictEqual(errorMessage, 'invalid-subscriptionid')
})
})
describe('invalid-subscription', () => {
it('ineligible querystring subscription is not active', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.invalidSubscription
assert.strictEqual(errorMessage, 'invalid-subscription')
})
})
})
describe('returns', () => {
it('boolean', async () => {
const deleted = cachedResponses.returns
assert.strictEqual(deleted, true)
})
})
})