ProAbono plugin

• The account number. Store account as 42 (or paste the endpoint, https://api-42.proabono.com) to reach api-42.proabono.com; an account plugin option overrides it. Without it there is no host to call, so the plugin asks for the connection rather than guessing.
• Two steps to a subscription. A subscription is created from an offer reference and a customer reference, and it only starts billing once the customer is billable. TryStart: false creates it without starting, so it can be customised first; start then begins it.
• Amounts are integer cents. Every amount, such as AmountRecurrence and an invoice’s AmountTotal, is in the currency’s minor unit, so 9900 is 99.00.
• Usages accumulate. usages.increment adds to a feature’s usage, and a negative increment subtracts, which is how a reversed action is recorded. Every usage change needs a DateStamp; ProAbono records two changes with the same timestamp once. usages.update sends up to 50 rows at once.
• Lists are paginated. List answers carry Page, SizePage, Count and TotalItems beside the rows; pass Page for the next page.
• A 204 is not an error. ProAbono answers a read that finds nothing with 204 and an empty body. The plugin turns that into an empty result rather than failing the parse.
• A 422 lists the bad fields. It carries one entry per field; the thrown ApiError keeps that list on body.
• Nothing to check a subscription with. The docs warn against using subscriptions.get to decide whether a user is a subscriber, and point at their own method instead.
• Webhooks. ProAbono notifies through its portal rather than by webhook deliveries, so this plugin receives none.

• 27 typed API operations

Setup

npm install corsair @corsair-dev/proabono better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/proabono better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/proabono better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/proabono better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { proabono } from '@corsair-dev/proabono';

export const corsair = createCorsair({
	plugins: [
		proabono(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

proabono()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'proabono',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.proabono.api.offers.list({});

const tenant = corsair.withTenant('acme');
await tenant.proabono.api.customers.create({ ReferenceCustomer: 'cust-42', Name: 'Jane Smith', Email: 'jane@example.com' });

What’s next