This library is a small wrapper around a subset of the Chargify API.
This library is actively used in production, however not all end points are used regularly. We do our best to keep up to date with changes, but focus primarily on our own needs. However, pull requests are always welcome!
Unfortunately, this repository is no longer being maintained. If you would like to take over maintenance of the repository, please open up an issue in this repository or otherwise contact us. We apologize if this is an inconvenience at all. We are going to freeze this archive. Feel free to fork it as you desire. Best of luck!
Chargify has rebranded as "Maxio", but all references for the time being will remain to the name "Chargify".
Usage is fairly straight-forward. See Configuration for more information about setting up and configuring the SDK.
CHARGIFY_ENVset to production to actually make callsCHARGIFY_API_KEYYour secret API keyCHARGIFY_SUBDOMAINThe subdomain for your account at Chargify
Testing requires an actual account (nothing is mocked, but that could be a good addition!). Make sure your subdomain, api key, etc are properly set.
IMPORTANT If you run all of the tests, there isn't currently a way to delete the following entities. As such, you will need to handle that in the GUI until a solution is provided in the official REST API:
- Product Family
A recent PR included a CLI. We will be moving it out into a separate repository. Do not rely on using it in this repo.
The following are improvements we would like to make, or would like PRs to address (reach out to us first to make sure no one else has started working on it though!):
-
Migrate all
makeCallandmakeEventsCallinvocations to the newmakeAPICallfunction. This includes modifying the INTERNAL allocation to the options struct. -
Update calls to take options structs with pointers; add new functions where deprecation would occur so we can maintain backwards compatibility.
Note that Chargify changes their API doc URLs regularly, so we have stopped providing links directly to the end points.
- Create Customer
- Delete Customer
- Get Customers
- Search for Customers
- List Events
- List Events for Subscription
- Total Event Count
- Event Ingestion
- Bulk Event Ingestion
- Create Payment Profile
- Delete Payment Profile
- Create Product Family
- Get Product Family
- Read Component By ID
- Read Component By Handle
- List Comonents for Product Family
- List Product Familiy via Site
- Create a Product
- Archive a Product
- Update a Product
- Get a Product By ID
- Get a Product By Handle
- Get a Product In Family
- Create Subscription
- Update Subscription
- Cancel Subscription - Immediately
- Cancel Subscription - Delayed
- Remove Delayed Cancellation
- List Subscriptions
- Purge a Subscription (only works in test mode!)
- Create a Coupon
- Find a Coupon
- Archive a Coupon
- List Coupons
Want to join an awesome team building cool products to improve the lives of pets and their owners? Send an email to engineering@wagz.com and let's find out if we're a good match! We are a remote-first company based in New Hampshire.
Pull Requests are welcome! See our CONTRIBUTING.md file for more information.