createRate

Requires commerce.tax:create.

Create a new rate.

Required headers

Go to Authentication for credential setup.

Arguments

• input MutationCreateRateInput! required
  • label String! required — A label for display.
  • value RateValueInput! required — The rate's value. Set percentage or amount, not both. For amount.value use integer minor units.
    • amount SimpleMoneyInput optional — The rate value represented as a fixed money amount. Required if percentage is not provided.
    • percentage String optional — The percentage applied by the rate, out of 100. Required if amount is not provided.
  • calculationMethod RateCalculationMethodEnum optional — The method to be used when applying the rate to a purchase amount.
  • createdAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
  • description String optional — A human-friendly description.
  • jurisdictionId ID optional — The ID of the jurisdiction in which this rate applies.
  • metafields [CreateMetafieldInput!] optional — Any metafields to be created and assigned to the new rate.
    • key String! required
    • namespace String! required
    • type String! required — Metafield value type. Prefer lowercase values such as string. Catalog rejects uppercase STRING; Tax currently accepts both.
    • value String! required
  • name String optional — A unique human-friendly identifier. If omitted, a name will be generated from the label value.
  • references [CreateReferenceInput!] optional — Any references to be created and assigned to the new rate.
    • origin String! required — The origin of the reference.
    • value String! required — The value of the reference.
  • status RateStatusEnum optional — The desired status.
  • updatedAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.

Possible returns

• Rate Rate — An individual tax rate.