Get Recurring All statuses | SchoolSet

curl https://app.schoolset.io/app/api/v1/system/payment/recurring/statuses/all \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Retrieved all recurring payment statuses successfully.",
  "data": [
    {
      "id": "recurring_001",
      "status": "active",
      "description": "Payment is currently active and processing.",
      "lastUpdated": "2024-06-10T09:15:00Z"
    },
    {
      "id": "recurring_002",
      "status": "paused",
      "description": "Payment has been temporarily paused by the user.",
      "lastUpdated": "2024-06-08T14:22:00Z"
    },
    {
      "id": "recurring_003",
      "status": "cancelled",
      "description": "Payment has been cancelled and will not process further.",
      "lastUpdated": "2024-05-30T11:00:00Z"
    }
  ]
}

Lists payment records for the active school context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

Successful GET response for /api/v1/system/payment/recurring/statuses/all.

statusstring

messagestring

datalist of maps from strings to any