Get tax rates

curl --request GET \
  --url https://us.api.flexprice.io/v1/taxes/rates \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/taxes/rates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/taxes/rates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/taxes/rates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/taxes/rates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "fixed_value": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "percentage_value": "<string>",
      "scope": "INTERNAL",
      "status": "published",
      "tax_rate_status": "ACTIVE",
      "tax_rate_type": "percentage",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

GET

taxes

rates

Get tax rates

curl --request GET \
  --url https://us.api.flexprice.io/v1/taxes/rates \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/taxes/rates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/taxes/rates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/taxes/rates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/taxes/rates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>",
      "environment_id": "<string>",
      "fixed_value": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "percentage_value": "<string>",
      "scope": "INTERNAL",
      "status": "published",
      "tax_rate_status": "ACTIVE",
      "tax_rate_type": "percentage",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

end_time

string

expand

string

limit

integer

Required range: 1 <= x <= 1000

offset

integer

Required range: x >= 0

order

enum<string>

Available options:

asc,

desc

scope

enum<string>

Available options:

INTERNAL,

EXTERNAL,

ONETIME

start_time

string

status

enum<string>

Available options:

published,

deleted,

archived

taxrate_codes

string[]

taxrate_ids

string[]

Response

items

object[]

Show child attributes

pagination

object

Show child attributes

API Documentation

Addons

Credit Grants

Entitlements

Alerts

AlertSettings

Checkout

Costs

Coupons

Coupon Associations

Credit Notes

Customers

Wallets

Invoices

Environments

Events

Features

Groups

Integrations

Marketplace

Payments

Plans

Prices

Price Units

RBAC

Secrets

Subscriptions

Tasks

Scheduled Tasks

Tax Associations

Tax Rates

Tenants

Usage Records

Users

Webhook Events

Workflows

Get tax rates

Authorizations

Query Parameters

Response