Skip to main content

Tax rules

Which tax applies to what, and at what rate — what invoice issuing consults.

CommandHTTPDescription
tax-rules listGET /v1/tax_rulesList tax rules
tax-rules createPOST /v1/tax_rulesCreate a tax rule
tax-rules getGET /v1/tax_rules/{id}Get a tax rule
tax-rules updatePATCH /v1/tax_rules/{id}Update a tax rule
tax-rules deleteDELETE /v1/tax_rules/{id}Delete a tax rule

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List tax rules
kobana billing tax-rules list \
  --fields "id,public_id,external_id,scope,priority"

# Get a tax rule
kobana billing tax-rules get --params '{"id": "TAX_RULE_ID"}'

# Create a tax rule
kobana billing tax-rules create \
  --json '{"name": "NAME", "scope": "global", "items": []}'

# Update a tax rule
kobana billing tax-rules update \
  --params '{"id": "TAX_RULE_ID"}' \
  --json '{"name": "NAME", "description": "DESCRIPTION", "priority": 0}'

# Delete a tax rule
kobana billing tax-rules delete --params '{"id": "TAX_RULE_ID"}' --dry-run

Next steps​