Retrieve card utilization - Slash

GET

/

v2

/

cards

/

{cardId}

/

utilization

Retrieve card utilization

curl --request GET \
  --url https://api.slash.com/v2/cards/{cardId}/utilization \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/cards/{cardId}/utilization', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/cards/{cardId}/utilization"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/cards/{cardId}/utilization"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "spent": {
    "amount": 123,
    "currency": "<string>"
  },
  "available": {
    "amount": 123,
    "currency": "<string>"
  },
  "resetsAt": "2023-11-07T05:31:56Z"
}

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

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

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

Path Parameters

cardId

string

required

Card id with the c_ prefix.

Response

The utilization.

Spend in the current period of the limit.

spent

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

spent.amount

integer

required

Amount in the currency's minor units.

spent.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

available

Money · object

What is left of the limit. Absent without a limit.

Hide child attributes

available.amount

integer

required

Amount in the currency's minor units.

available.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

resetsAt

string<date-time>

When the period ends. Absent without a limit or for lifetime.

⌘I

Retrieve card utilization

curl --request GET \
  --url https://api.slash.com/v2/cards/{cardId}/utilization \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/cards/{cardId}/utilization', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/cards/{cardId}/utilization"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/cards/{cardId}/utilization"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "spent": {
    "amount": 123,
    "currency": "<string>"
  },
  "available": {
    "amount": 123,
    "currency": "<string>"
  },
  "resetsAt": "2023-11-07T05:31:56Z"
}