v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Convenience Fees

Get convenience fee rules

Returns all jurisdiction rules configured for the authenticated account. Each rule defines a jurisdiction (province/state) where convenience fees will not be collected. Requires the ViewConvenienceFees permission.

get/account/convenience-fees/rules

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "Rules": [
    {
      "RuleID": 5,
      "Jurisdiction": "BC",
      "Country": "CA"
    }
  ]
}