https://github.com/pyrox18/billplz
A Go wrapper for the Billplz REST API
https://github.com/pyrox18/billplz
Last synced: 11 months ago
JSON representation
A Go wrapper for the Billplz REST API
- Host: GitHub
- URL: https://github.com/pyrox18/billplz
- Owner: pyrox18
- License: mit
- Created: 2018-04-23T09:35:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-23T09:37:21.000Z (about 8 years ago)
- Last Synced: 2025-06-11T16:26:13.290Z (about 1 year ago)
- Language: Go
- Size: 27.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyrox18/billplz
A Go wrapper for the [Billplz REST API](https://www.billplz.com/api).
## Installation
Assuming a correctly configured Go toolchain, run
```bash
$ go get -u github.com/pyrox18/billplz
```
This project also uses [dep](https://github.com/golang/dep), so if dep is installed, `dep ensure` can be run to install the dependencies in the project folder.
## Usage
Example:
```go
import "github.com/pyrox18/billplz"
func main() {
// Initialise a new client
c, err := billplz.NewClient(nil, "BILLPLZ_API_KEY_HERE", true);
// Get a set of collections
collections, err := c.GetCollectionIndex(1, "");
// Do whatever with the collections
}
```
Refer to the [documentation](https://godoc.org/github.com/pyrox18/billplz) for details on available types and functions.
## Billplz API Version Support
This package makes requests to version 3 of the Billplz REST API. Features in version 4 are not supported.
## License
This package is licensed under the MIT license. See the LICENSE file for details.