lib-billing-client

API for using and managing premium subscriptions with Doodle.

:warning: :boom: THIS MODULE IS STILL A WIP and should ONLY BE USED for local development and automated testing in staging, preproduction and devboxes for now. Please do not bundle this module in your production apps until it has been properly vetted.

Modules

This library exports both CommonJS and ES modules via rollup.

Usage

In order to use this client library, your application needs to expose the following environment variables:

• SVC_BILLING_BASE_URL is the base url for service billing
• MONOLITH_API_BASE_URL is the base url for all monolith API calls
• SUPER_USER_EMAIL Needed for tasks that only a superuser can perform
• SUPER_USER_PASSWORD Needed for tasks that only a superuser can perform

# Staging: https://ambassador-stg.kubernetes.doodle-test.com/billing/v1
# Preprod: https://ambassador.doodle-test.com/billing/v1
SVC_BILLING_BASE_URL=

# Staging: https://ambassador-stg.doodle-test.com
# Preprod: https://ambassador.doodle-test.com
MONOLITH_API_BASE_URL=

# Needed only for some client utilities; e.g., permanent deletion of mandators
SUPER_USER_EMAIL=
SUPER_USER_PASSWORD=

Example

import { getAllSubscriptionsForUser } from '@doodle/billing-client';

(async () => {
  try {
    const subscriptions = await getAllSubscriptionsForUser('myAccessToken');
    console.log(subscriptions);
  } catch (error) {
    // Handle error
  }
})();

Development

If you want to develop this library, then you can:

1. Run yarn run watch (to put rollup into watch mode)

When you are done developing locally:

1. Stop the watch process that started after running yarn run watch with CTRL + C

Linking

If you want to test your development version in a local project:

1. Run yarn link in the root directory of this library
2. Run yarn link @doodle/billing-client in the project where you are importing this library

When you are done linking the local version:

1. Run yarn unlink in the root directory of this library
2. Run yarn unlink @doodle/billing-client in the project where you were importing this library
3. Reinstall the dependencies in the project where you were importing this with yarn install --force

Install

$ yarn add @doodle/billing-client

Plans

For your reference, below is a list of all the subscriptions plans we use at Doodle. You can fetch all of these plans via the .getAllDoodlePlans() method. Simmilaly, if you need to look up a plan based on its planId, you can look it up with .getDoodlePlanById(planId: Number)

Publish

This module uses TagFlow :tm: to publish. This means you just need to create tags with a special syntax: pub.<VERSION>

Example via the terminal (requires the repo to be cloned locally):

$ git tag pub.X.X.X
$ git push origin pub.X.X.X

where X.X.X represents the version number you want to release.

:bulb: You can still publish this TagFlow-enabled module without needing the repo cloned locally, simply use GitHub releases to create the tag using the same syntax: pub.X.X.X

:rainbow: :hamburger: