# cheddargetter

> Wrapper for the CheddarGetter recurring billing system APIs

Latest version **0.1.4-1** (published 2012-05-20) · 0 weekly downloads

## Install

```sh
npm install cheddargetter
pnpm add cheddargetter
yarn add cheddargetter
bun add cheddargetter
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4-1 |
| Published | 2012-05-20 |
| First published | 2011-11-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+6 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Kevin Smith |
| Maintainers | respectthecode |

## Links

- npm: https://www.npmjs.com/package/cheddargetter
- Repository: https://github.com/respectTheCode/node-cheddargetter
- npm.io page: https://npm.io/package/cheddargetter

## Dependencies (3)

- [qs](https://npm.io/package/qs.md) 0.3.x
- [async](https://npm.io/package/async.md) 0.1.x
- [xml2js](https://npm.io/package/xml2js.md) 0.1.x

## Recent versions

- 0.1.4-1 (latest) — 2012-05-20
- 0.1.4 — 2012-05-20
- 0.1.3 — 2012-05-01
- 0.1.2 — 2012-05-01
- 0.1.1 — 2012-04-30
- 0.0.4 — 2011-11-30
- 0.0.3 — 2011-11-07
- 0.0.2 — 2011-11-05
- 0.0.1 — 2011-11-04

## README

# Goals and Status

This module will simplify the process of integrating CheddarGetter into your existing node.js apps.

As of version 0.1.4 the module implements the fallowing API calls:

* `getAllPricingPlans(callback)`
* `getPricingPlan(planCode, callback)`
* `getAllCustomers([searchParams], callback)`
* `getCustomer(customerCode, callback)`
* `createCustomer(customerData, callback)`
* `editCustomerAndSubscription(customerData, callback)` or `updateCustomerAndSubscription(customerData, callback)`
* `editCustomer(customerCode, customerData, callback)` or `updateCustomer(customerCode, customerData, callback)`
* `editSubscription(customerCode, customerData, callback)` or `updateSubscription(customerCode, customerData, callback)`
* `deleteCustomer(customerCode, callback)`
* `cancelSubscription(customerCode, callback)`
* `addItem(customerCode, itemCode, [amount], callback)`
* `removeItem(customerCode, itemCode, [amount], callback)`
* `setItemQuantity(customerCode, itemCode, amount, callback)`
* `addCustomCharge(customerCode, chargeCode, quantity, amount, description, callback)`
* `deleteCustomCharge(customerCode, chargeId, callback)`

All callbacks are called with `error` and `results` parameters.

Not all API calls have been fully tested and many unit tests are still missing.

# Install

```
npm install cheddargetter
```

# Usage

```javascript
var CheddarGetter = require("CheddarGetter");
	
var cg = new CheddarGetter("test@test.com", "TestPass", "ProdCode");
	
cg.getAllPricingPlans(function (err, results) {
	console.log(err, results);
});
```
# Tests

```
node test
```

---
_Source: https://npm.io/package/cheddargetter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._