Errors

We use standard HTTP response codes to let you know the result of your request. In case of failure, we will also returns some useful information to help you troubleshoot.

HTTP status codes

status code	state	expect
2xx	Success	Everything is okay.
201	Success	Created. The resource is created.
202	Success	Accepted. The request is being handled, do not expect response. You may receive a callback.
304	Success	Not modified. When handling idempodent requests, we may return 304 if the request is duplicated.
400	Failure	Bad request. Review the request body. We will try to explain the bad details in the response.
401	Failure	Unauthorized. Authenticate with access token.
402	Failure	Payment required. Your subscription requires a high tier.
403	Failure	Forbidden. Either the resource access is denied or your access token expired.
404	Failure	Not found. Either the resource of a dependency is not found.
409	Failure	Not found. Either the resource of a dependency is not found.
429	Failure	Conflict. The request looks good, but we have an issue handling the request.
500	Critical	We are sorry. It’s on us. We have an unhandled error, and staff is notified.

Response details

Unless we return a HTTP 2XX response, you can expect a common response object as below:

{
    "type" : "customer not found",
    "title" : "No customer with id xxxxxxx exists.",
    "status" : "400",
    "detail" : "The customer does not exist.",
    "traceId" : "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}

This response include standard guidance how to resolve the failure.

Tracking response

When engaging our support, please include any x-request-id and the traceId. Our API support that you add your own correlation-id using the x-request-id header. We will always return a x-trace-id.

Welcome

Accounts

Accountsets

Analytics

Authorization

Customers

Discounts

Dunningplans

Environments

Invoices

Paymentproviders

Payments

Prices

Products

Profile

Subscriptions

Templates

Usageevents

Webhooks

HTTP status codes

Response details

Tracking response

​HTTP status codes

​Response details

​Tracking response

HTTP status codes

Response details

Tracking response