Create a tax rate

curl --request POST \
  --url https://us.api.flexprice.io/v1/taxes/rates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "fixed_value": "<string>",
  "metadata": {},
  "percentage_value": "<string>"
}
'

import requests

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

payload = {
    "code": "<string>",
    "name": "<string>",
    "description": "<string>",
    "fixed_value": "<string>",
    "metadata": {},
    "percentage_value": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    name: '<string>',
    description: '<string>',
    fixed_value: '<string>',
    metadata: {},
    percentage_value: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'fixed_value' => '<string>',
    'metadata' => [
        
    ],
    'percentage_value' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/taxes/rates")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}"

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

{
  "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>"
}

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

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

POST

taxes

rates

Create a tax rate

curl --request POST \
  --url https://us.api.flexprice.io/v1/taxes/rates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "fixed_value": "<string>",
  "metadata": {},
  "percentage_value": "<string>"
}
'

import requests

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

payload = {
    "code": "<string>",
    "name": "<string>",
    "description": "<string>",
    "fixed_value": "<string>",
    "metadata": {},
    "percentage_value": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    name: '<string>',
    description: '<string>',
    fixed_value: '<string>',
    metadata: {},
    percentage_value: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'fixed_value' => '<string>',
    'metadata' => [
        
    ],
    'percentage_value' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/taxes/rates")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"fixed_value\": \"<string>\",\n  \"metadata\": {},\n  \"percentage_value\": \"<string>\"\n}"

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

{
  "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>"
}

{
  "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>*

Body

application/json

Tax rate to create

code

string

required

code is the unique alphanumeric case sensitive identifier for the tax rate (required)

name

string

required

name is the human-readable name for the tax rate (required)

description

string

description is an optional text description providing details about the tax rate

fixed_value

string

fixed_value is the fixed monetary amount when tax_rate_type is "fixed"

metadata

object

metadata contains additional key-value pairs for storing extra information

Show child attributes

percentage_value

string

percentage_value is the percentage value (0-100) when tax_rate_type is "percentage"

scope

enum<string>

Available options:

INTERNAL,

EXTERNAL,

ONETIME

tax_rate_type

enum<string>

Available options:

percentage,

fixed

Response

Created

code

string

created_at

string<date-time>

created_by

string

description

string

environment_id

string

fixed_value

string

metadata

object

Show child attributes

name

string

percentage_value

string

scope

enum<string>

Available options:

INTERNAL,

EXTERNAL,

ONETIME

status

enum<string>

Available options:

published,

deleted,

archived

tax_rate_status

enum<string>

Available options:

ACTIVE,

INACTIVE

tax_rate_type

enum<string>

Available options:

percentage,

fixed

tenant_id

string

updated_at

string<date-time>

updated_by

string

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

Create a tax rate

Authorizations

Body

Response