Get Contribution Summary

GET/users/{user_id}/accounts/{account_id}/contributions/summary

Year-to-date contribution total, applicable IRS limit, and remaining headroom, the “help users max out their HSA” use case in one call. Requires the benefit_account scope and product.

Path Parameters

user_idstringrequired

The Sail user id.

account_idstringrequired

The Sail account id.

Query Parameters

tax_yearinteger

Defaults to the current tax year.

Response

Contribution summary.

account_idstring

The Sail account id.

tax_yearinteger

The tax year this summary covers.

ytd_totalnumber<float>

Total contributions made so far this tax year.

annual_limitnumber<float>

Applicable IRS limit for the account holder’s coverage tier.

remainingnumber<float>

Headroom remaining before the annual limit is reached.

coverage_tier"self_only" | "family" | "unknown"

The account holder’s HSA coverage tier, which determines the applicable IRS limit.

as_ofstring<date-time>

When this summary was computed.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties

codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

const response = await fetch(`https://live.savewithsail.com/api/v1/users/${user_id}/accounts/${account_id}/contributions/summary`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://live.savewithsail.com/api/v1/users/{user_id}/accounts/{account_id}/contributions/summary", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/contributions/summary"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/contributions/summary", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/contributions/summary")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/contributions/summary") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body