Skip to main content
GET
Retrieve a cashback rate

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request except GET /v2/legal-entities, which lists the ids a user API key can send here: those of every legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

accountId
string
required

Account id with the sa_group_ prefix.

Response

The account's cashback rate.

What one account's card spend earns this month.

accountId
string
required

Account id with the sa_group_ prefix.

Example:

"sa_group_2rj4l7hmrrrcv"

current
number
required

The account's standard rate now, as a fraction; 0.015 is 1.5%. Some purchases may earn a different rate.

Example:

0.015

tiers
object[]
required

Rates by card spend this month, lowest minimum first. A tier's rate can be higher or lower than the one before. Spend below the first tier's minimum earns nothing. A flat rate has one tier.

cycleSpend
Money · object

Card spend this month that counts toward the tiers. Only on plans where spend decides the rate.

spendToNextTier
Money · object

More card spend this month needed to reach the next tier. Only on plans where spend decides the rate, and absent on the last tier.