Coverage · GET
Check coverage
Checks whether the API supports the supplied jurisdiction, item tax code, transaction type, customer type, and date. A country list alone does not confirm support.
/v1/coverageParameters
Send these headers and path or query values with the request.
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Send your API key as a bearer token. |
country | string | Yes | ISO 3166-1 alpha-2 country code. |
state | string | No | Subdivision code when applicable. |
tax_code | string | Yes | |
transaction_type | string | Yes | |
customer_type | string | No | |
date | string | No | ISO date to evaluate. Defaults to the server's current UTC date. |
Responses
All three coverage outcomes use HTTP 200. Check the response's outcome field.
Headers: Request-Id
The request shape, parameter, or header is invalid.
A valid API key is required.
Headers: WWW-Authenticate
The authenticated key cannot perform this operation.
The request exceeded an API safety limit. It did not count toward API usage.
Headers: Retry-After
A required service is unavailable, so the API could not process the request.
Headers: Retry-After
Live request
Try this endpoint
The browser sends the request straight to the API. Your API key never passes through this website's server.
