Introduction

Overview

The Stax Bill API is a REST-based HTTP API. It makes use of standard HTTP authentication, verbs, and error codes.

Stax Bill ensures the API platform is stable and performs well under the stresses of real-world use. New features are first launched against a private API resource. New API features are made public after the feature has been fully vetted in the Stax Bill Admin application.

Stax Bill API Status

Check the status of the Stax Bill API platform and subscribe to notifications about the state of the service.

📘

Check the Stax Bill API Status:

Stax Bill Status: status.staxbill.com
Stax Bill Staging environment Status: stagingstatus.staxbill.com

Versioning

Stax Bill's API is versioned following the Semantic Versioning 2.0.0 guidelines. Our version number format is MAJOR.MINOR.PATCH.

Version number increments are made according to the following rules:

MAJOR

Major number is incremented when breaking API changes.

MINOR

Minor number is incremented when backwards compatible new functionality is added to the API platform.

PATCH

Patch number is incremented when backwards compatible bug fixes are made.

Errors & Rate Limiting

Stax Bill uses conventional HTTP response codes to indicate the success or failure of an API request.

Additionally, the Stax Bill API is rate-limited under the following constraints:

  • Maximum of 1,000 requests per minute
  • Maximum of 180,000 requests per day

Please see our Rate Limits section for full details.