Stripe Subscriptions module API explorer

/api/administrator/subscriptions/product (GET)

Account information like email addresses is generated with faker-js it is not real user information.

await global.api.administrator.subscriptions.Product.get(req)

Returns object

{
  "productid": "prod_LwGubbhMKnDmea",
  "object": "product",
  "stripeObject": {
    "id": "prod_LwGubbhMKnDmea",
    "object": "product",
    "active": true,
    "attributes": [],
    "created": 1656122683,
    "default_price": null,
    "description": null,
    "images": [],
    "livemode": false,
    "metadata": {},
    "name": "product185",
    "package_dimensions": null,
    "shippable": null,
    "statement_descriptor": "product185 description",
    "tax_code": "txcd_41060003",
    "type": "service",
    "unit_label": "thing",
    "updated": 1656122683,
    "url": null
  },
  "active": true,
  "appid": "tests_1656122683",
  "createdAt": "2022-06-25T02:04:43.609Z",
  "updatedAt": "2022-06-25T02:04:43.610Z"
}

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-productid missing querystring productid
invalid querystring productid

NodeJS source (view on github)

const dashboard = require('@layeredapps/dashboard')
const subscriptions = require('../../../../../index.js')

module.exports = {
  get: async (req) => {
    if (!req.query || !req.query.productid) {
      throw new Error('invalid-productid')
    }
    let product = await dashboard.StorageCache.get(req.query.productid)
    if (!product) {
      const productInfo = await subscriptions.Storage.Product.findOne({
        where: {
          productid: req.query.productid,
          appid: req.appid || global.appid
        }
      })
      if (!productInfo) {
        throw new Error('invalid-productid')
      }
      product = {}
      for (const field of productInfo._options.attributes) {
        product[field] = productInfo.get(field)
      }
      await dashboard.StorageCache.set(req.query.productid, product)
    }
    return product
  }
}

Test source (view on github)

/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')

describe('/api/administrator/subscriptions/product', function () {
  before(TestHelper.disableMetrics)
  after(TestHelper.enableMetrics)
  describe('exceptions', () => {
    describe('invalid-productid', () => {
      it('missing querystring productid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/subscriptions/product')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-productid')
      })

      it('invalid querystring productid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/subscriptions/product?productid=invalid')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-productid')
      })
    })
  })

  describe('returns', () => {
    it('object', async () => {
      const administrator = await TestHelper.createOwner()
      await TestHelper.createProduct(administrator, {
        active: 'true'
      })
      const req = TestHelper.createRequest(`/api/administrator/subscriptions/product?productid=${administrator.product.productid}`)
      req.account = administrator.account
      req.session = administrator.session
      req.filename = __filename
      req.saveResponse = true
      const product = await req.get()
      assert.strictEqual(product.productid, administrator.product.productid)
    })
  })
})