Commitments

Get donor sponsorship management options

Returns current financial state, effective management mode, available frequencies/date window and action-specific blockers. Requires exactly one matching donor-owned type1 commitment and visible payment details; unsupported relationships return422. Online writes require direct/approval program mode and workspace rollout. A pending request blocks additional changes. Provider subscriptions, nonbilling/zero/nonrecurring commitments, expired schedules or processing payments require staff help; cancellation also requires active donor_cancelled reason with no notes. Schedule changes also block due/past-due/retry payments. Uses a logged-in donor session for this organization and a valid portal program/global context; the session TTL refreshes to one hour. Only that donor’s relationships or requests can be accessed.

GET

frontend

donor

dashboard

sponsorships

{client_id}

{program_id}

{session_id}

{donor_entity_id}

Get donor sponsorship management options

curl --request GET \
  --url https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}

const options = {method: 'GET'};

fetch('https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "donor_entity_id": 42,
    "commitment_id": 42,
    "management_mode": "disabled",
    "latest_request": {
      "id": 42,
      "donor_entity_id": 42,
      "commitment_id": 42,
      "program_id": 42,
      "status": "pending",
      "action": "change",
      "program_name": "Example",
      "donor_name": "Example",
      "recipient_name": "Example",
      "review_note": "Example",
      "currency_symbol": "Example",
      "created_at": "2026-10-20T12:00:00Z",
      "reviewed_at": "2026-10-20T12:00:00Z",
      "current": {
        "raw_amount": 25,
        "per_period_charge": 25,
        "monthly_equivalent": 25,
        "frequency": 1,
        "amount_basis": false,
        "method": 3,
        "next_action_date": "2026-11-01",
        "end_date": "2026-11-01"
      },
      "projected": {
        "raw_amount": 25,
        "per_period_charge": 25,
        "monthly_equivalent": 25,
        "frequency": 1,
        "amount_basis": false,
        "method": 3,
        "next_action_date": "2026-11-01",
        "end_date": "2026-11-01"
      },
      "payment_behavior": "automatic_charge"
    },
    "current": {
      "raw_amount": 25,
      "per_period_charge": 25,
      "monthly_equivalent": 25,
      "frequency": 1,
      "amount_basis": false,
      "method": 3,
      "next_action_date": "2026-11-01",
      "end_date": "2026-11-01",
      "method_label": "Credit card"
    },
    "currency_symbol": "Example",
    "payment_behavior": "automatic_charge",
    "editable": false,
    "can_cancel": false,
    "blocked_reason": "Example",
    "blocked_code": "Example",
    "cancel_blocked_reason": "Example",
    "frequencies": [
      {
        "value": 1,
        "label": "Monthly"
      }
    ],
    "earliest_next_action_date": "2026-11-01",
    "latest_next_action_date": "2026-11-01",
    "paid_through_date": "2026-11-01"
  }
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}

Path Parameters

client_id

integer

required

Record ID in the authenticated organization.

Example:

42

program_id

string

required

Owned portal program ID or none for the organization-wide portal.

Example:

"none"

session_id

string

required

Logged-in donor session token for the requested organization; refreshed to one hour.

Example:

"donor-session-token"

donor_entity_id

integer

required

Record ID in the authenticated organization.

Example:

42

Response

Get donor sponsorship management options completed.

status

enum<string>

Operation success.

Available options:

success

Example:

"success"

data

object

Show child attributes

Get donor sponsorship management options

curl --request GET \
  --url https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}

const options = {method: 'GET'};

fetch('https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "donor_entity_id": 42,
    "commitment_id": 42,
    "management_mode": "disabled",
    "latest_request": {
      "id": 42,
      "donor_entity_id": 42,
      "commitment_id": 42,
      "program_id": 42,
      "status": "pending",
      "action": "change",
      "program_name": "Example",
      "donor_name": "Example",
      "recipient_name": "Example",
      "review_note": "Example",
      "currency_symbol": "Example",
      "created_at": "2026-10-20T12:00:00Z",
      "reviewed_at": "2026-10-20T12:00:00Z",
      "current": {
        "raw_amount": 25,
        "per_period_charge": 25,
        "monthly_equivalent": 25,
        "frequency": 1,
        "amount_basis": false,
        "method": 3,
        "next_action_date": "2026-11-01",
        "end_date": "2026-11-01"
      },
      "projected": {
        "raw_amount": 25,
        "per_period_charge": 25,
        "monthly_equivalent": 25,
        "frequency": 1,
        "amount_basis": false,
        "method": 3,
        "next_action_date": "2026-11-01",
        "end_date": "2026-11-01"
      },
      "payment_behavior": "automatic_charge"
    },
    "current": {
      "raw_amount": 25,
      "per_period_charge": 25,
      "monthly_equivalent": 25,
      "frequency": 1,
      "amount_basis": false,
      "method": 3,
      "next_action_date": "2026-11-01",
      "end_date": "2026-11-01",
      "method_label": "Credit card"
    },
    "currency_symbol": "Example",
    "payment_behavior": "automatic_charge",
    "editable": false,
    "can_cancel": false,
    "blocked_reason": "Example",
    "blocked_code": "Example",
    "cancel_blocked_reason": "Example",
    "frequencies": [
      {
        "value": 1,
        "label": "Monthly"
      }
    ],
    "earliest_next_action_date": "2026-11-01",
    "latest_next_action_date": "2026-11-01",
    "paid_through_date": "2026-11-01"
  }
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}

{
  "status": "error",
  "code": "preview_stale",
  "message": "Review the latest sponsorship details again."
}