Commitments

Review a donor sponsorship change

Creates a ten-minute, session-bound one-time review without writing the payment schedule. Only the documented properties are accepted. Change preserves the monthly-equivalent contribution and re-expresses a per-period amount for the selected frequency; cancellation preserves historical payments/paid coverage. The review explains direct application or approval consequences. 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.

POST

frontend

donor

dashboard

sponsorships

{client_id}

{program_id}

{session_id}

{donor_entity_id}

preview

Review a donor sponsorship change

curl --request POST \
  --url https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "change",
  "frequency": 1,
  "next_action_date": "2026-12-01"
}
'

import requests

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

payload = {
    "action": "change",
    "frequency": 1,
    "next_action_date": "2026-12-01"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'change', frequency: 1, next_action_date: '2026-12-01'})
};

fetch('https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview', 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}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => 'change',
    'frequency' => 1,
    'next_action_date' => '2026-12-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}")
  .asString();

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}/preview")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}"

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

{
  "status": "success",
  "data": {
    "action": "change",
    "management_mode": "disabled",
    "donor_entity_id": 42,
    "commitment_id": 42,
    "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"
    },
    "currency_symbol": "Example",
    "payment_behavior": "automatic_charge",
    "preview_token": "d38103d8-1e8b-47ab-ae04-7e1f8a3bc727",
    "preview_expires_at": "2026-10-20T12:00:00Z",
    "message": "Confirming updates your future payment schedule. You will not be charged now.",
    "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."
}

{
  "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

Body

application/json

Option 1
Option 2

action

enum<string>

required

Review frequency/next-date change.

Available options:

change

Example:

"change"

frequency

enum<integer>

required

Choose from frequencies returned by sponsorship detail; biweekly6 supports date-only changes.

Available options:

1,

2,

3,

4,

6,

7

Example:

1

next_action_date

string<date>

required

Date inside the detail response window.

Example:

"2026-12-01"

Response

Review a donor sponsorship change completed.

status

enum<string>

Operation success.

Available options:

success

Example:

"success"

data

object

Show child attributes

Review a donor sponsorship change

curl --request POST \
  --url https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "change",
  "frequency": 1,
  "next_action_date": "2026-12-01"
}
'

import requests

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

payload = {
    "action": "change",
    "frequency": 1,
    "next_action_date": "2026-12-01"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'change', frequency: 1, next_action_date: '2026-12-01'})
};

fetch('https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview', 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}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => 'change',
    'frequency' => 1,
    'next_action_date' => '2026-12-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}")
  .asString();

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}/preview")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"change\",\n  \"frequency\": 1,\n  \"next_action_date\": \"2026-12-01\"\n}"

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

{
  "status": "success",
  "data": {
    "action": "change",
    "management_mode": "disabled",
    "donor_entity_id": 42,
    "commitment_id": 42,
    "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"
    },
    "currency_symbol": "Example",
    "payment_behavior": "automatic_charge",
    "preview_token": "d38103d8-1e8b-47ab-ae04-7e1f8a3bc727",
    "preview_expires_at": "2026-10-20T12:00:00Z",
    "message": "Confirming updates your future payment schedule. You will not be charged now.",
    "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."
}

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