Chargebee Partner docs

API Reference

App Onboarding

Support

Checks whether the tax address is valid in terms of tax calculation. This endpoint checks whether the address information of the customer is sufficient for the tax provider to return a tax rate. It does not consider the nexus status of the merchant and is mandatory to integrate for the tax provider.

Check taxability

Represents the address used for validation.

The country of the address following the ISO 3166-1 alpha-2 standard.

The state of the address following the ISO 3166-2 state/province code without the country prefix.

The error codes classify the type of exception that occurred during processing the request.

The health status details of a specific component reported by the Service Adapter.

name

When the `status` of the component is not `UP`, then the list of endpoints affected.

The type of component affected when `status` is `WARN` or `DOWN`. The possible values are:
- `ADAPTER`: The reported status is for the Service Adapter.
- `API`: The reported status is for the Service Provider.
- `DATABASE`: The reported status is for a database dependency of the Service Provider.
- `SYSTEM`: The reported status is for any other known system component such as cache or gateway.
- `OTHER`: The reported status is either for a component that does not belong to the types described above or the source of the issue is unknown.


The status of a specific component reported by the Service Adapter.

The target entity that has the invalid field or value.

The field of an entity that has the invalid value.

The link to the documentation for more information about the error and the corrective action.

A short message describing the reason for the error.

Non-taxable address with combination of city,state,country,postalCode sent in a post request

Non-taxable address request (city + state + country + postalCode)

Shows a non-taxable address sent in a post request

Non-taxable address request (city + country + postalCode)

Non-taxable address with combination of city,state,postalCode sent in a post request

Taxable address with combination of city,state,country,postalCode sent in a post request

Taxable address request (city + state + country + postalCode)

Taxable address with combination of city,country,postalCode sent in a post request

Taxable address request (city + country + postalCode)

Taxable address with combination of city,state,postalCode sent in a post request

The taxability request containing the address. Postal code & Country is mandatory.

bearerAuth

apiKey

Invalid Response based on combination of city,state,country,postalCode sent in a post request

Non-taxable address  Response (city + state + country + postalCode)

Invalid response based on combination of city,country,postalCode sent in a post request

Non-taxable address response (city + country + postalCode)

Non-taxable address response based on combination of city,state,postalCode sent in a post request

Non-taxable address response (postalCode)

Valid Response based on combination of city,state,country,postalCode sent in a post request

Taxable address  Response (city + state + country + postalCode)

Valid Response based on combination of city,country,postalCode sent in a post request

Taxable address response (city + country + postalCode)

Valid response based on combination of city,state,postalCode sent in a post request

The error response for validation errors with the respective entity and its field information.

Unexpected error during processing the request.

The basic error response containing the error message and the help documentation link.

Overview

Testing with Postman

Guide to integrate your app with Chargebee and list it on Chargebee’s marketplace.

API Reference

Check taxability

Authorizations

Body

Response