Tax Rates

Update a tax rate

Changed on

Use when changing a tax rate (e.g. rate value or name). Request body contains the fields to update.

put/taxes/rates/{id}

Request

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

Path parameters

idstring required

Tax rate ID

Request body

codestring

code is the updated unique alphanumeric identifier for the tax rate

descriptionstring

description is the updated text description for the tax rate

metadataobject

metadata contains updated key-value pairs that will replace existing metadata

namestring

name is the updated human-readable name for the tax rate

tax_rate_status'ACTIVE' | 'INACTIVE'

Response

OK

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
    • 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