Recharge API Client for Node.js

A Node.js client for the Recharge Payments API covering both the 2021-01 and 2021-11 API versions.

Installation

npm install @chemicalLuck/recharge-api-node

Usage

import { Recharge } from "@ChemicalLuck/recharge-api-node";

const recharge = new Recharge("your-api-key");

// v1 (2021-01) API
const addresses = await recharge.v1.address.list(customerId);
const customer = await recharge.v1.customer.get(customerId);

// v2 (2021-11) API
const subscriptions = await recharge.v2.subscription.list();
const paymentMethods = await recharge.v2.paymentMethod.list();

Error handling

Non-2xx responses throw an HTTPResponseError that exposes the status code and the parsed error body returned by Recharge:

import { Recharge, HTTPResponseError } from "@ChemicalLuck/recharge-api-node";

try {
  await recharge.v2.customer.get(123);
} catch (error) {
  if (error instanceof HTTPResponseError) {
    console.error(error.status); // e.g. 422
    console.error(error.body); // parsed JSON error payload from Recharge
  }
}

Requests are automatically retried (up to 3 times) on 429 and 5xx responses, honouring the Retry-After header when present. list methods transparently follow pagination (Link headers for 2021-01, cursors for 2021-11) and return the full result set.

Resources

v1 (2021-01)

| Resource | Methods | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | address | create, get, update, delete, list, count, validate, applyDiscount | | asyncBatch | create, get, list, process, createTask, listTasks | | charge | get, list, count, change_next_charge_date, skip, unskip, refund, process, capture, apply_discount, remove_discount | | checkout | create, get, update, get_shipping_rates, process | | customer | create, get, update, delete, list, count, payment_sources | | discount | create, get, update, delete, list, count, applyToAddress, applyToCharge, remove | | metafield | create, get, update, delete, list, count | | notification | send | | onetime | create, get, update, delete, list | | order | get, update, delete, list, count, change_date, change_variant, clone, delay | | product | create, get, update, delete, list, count | | shop | get, shipping_countries | | subscription | create, get, update, delete, list, count, changeNextChargeDate, changeAddress, cancel, activate, bulkCreate, bulkUpdate, bulkDelete | | token | token_information | | webhook | create, get, update, delete, list, test |

v2 (2021-11)

| Resource | Methods | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | account | get, list | | address | create, get, update, delete, list, merge, skipFutureCharge | | asyncBatch | create, get, list, process, createTask, listTasks | | bundleSelection | create, get, update, delete, list | | charge | get, list, applyDiscount, removeDiscount, skip, unskip, refund, process, capture, addFreeGift, removeFreeGift | | checkout | create, get, update, getShippingRates, process | | collection | create, get, update, delete, list, listProducts, addProducts, removeProducts | | credit | create, get, update, list, createAdjustment, listAdjustments, listAllAdjustments | | customer | create, get, update, delete, list, deliverySchedule, creditSummary | | discount | create, get, update, delete, list | | entitlement | create, update, delete, list | | event | list | | metafield | create, get, update, delete, list | | notification | sendEmail | | onetime | create, get, update, delete, list | | order | get, update, delete, list, clone, delay | | paymentMethod | create, get, update, delete, list | | plan | create, update, delete, list, bulkCreate, bulkUpdate, bulkDelete | | product | create, get, update, delete, list | | store | get | | subscription | create, get, update, delete, list, setNextChargeDate, changeAddress, cancel, activate, gift | | token | get | | webhook | create, get, update, delete, list, test |

Recharge Documentation

• Recharge API 2021-01
• Recharge API 2021-11
• Recharge Storefront Client Types

License

MIT