Tax Rates

Create a tax rate

Changed on

Use when defining a new tax rate (e.g. VAT or sales tax) for use in invoices. Attach to customers or products via tax associations.

post/taxes/rates

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/taxes/rates
  • Auth
    API key in header x-api-key

Request body

codestring required

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

descriptionstring

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

metadataobject

metadata contains additional key-value pairs for storing extra information

namestring required

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

percentage_valuestring

percentage_value is the percentage value (0-100)

scope'INTERNAL' | 'EXTERNAL' | 'ONETIME'
tax_rate_type'percentage'

Response

Created

codestring
created_atstring date-time
created_bystring
descriptionstring
environment_idstring
idstring
metadataobject
namestring
percentage_valuestring
scope'INTERNAL' | 'EXTERNAL' | 'ONETIME'
status'published' | 'deleted' | 'archived'
tax_rate_status'ACTIVE' | 'INACTIVE'
tax_rate_type'percentage'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes

  • e1d4e27b5677Revision changes
    • breaking

      removed the enum value fixed of the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      removed the fixed enum value from the response property for the response status

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status