VTU API
Get API keys
Schedule Payments›Manage

Update schedule

PUT https://api.paybeta.ng/v2/scheduled-payments/{scheduleReference}

Edit a schedule before its first run (can_edit: true). Same body and rules as Create; the schedule restarts from the new start_at.

Send your secret key in the P-API-KEY header. Keep it on your server, never in an app or browser.

Path parameters

  • scheduleReference string Required
    Example: SCH-9SC5QIH5GNLC

Body (JSON)

  • service string Required
    Example: data
  • biller string Required
    Example: mtn_data
  • customer_id string Required
    Example: 08031234567
  • code string Required
    Example: mtn-2gb-30days
  • frequency string Required
    Example: monthly
  • start_at string Required
    Example: {{startAt}}

Responses

  • 200Success
  • 404Error
  • 422Error
Request
curl --request PUT \
  --url 'https://api.paybeta.ng/v2/scheduled-payments/{scheduleReference}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'P-API-KEY: YOUR_SECRET_KEY' \
  --data '{
    "service": "data",
    "biller": "mtn_data",
    "customer_id": "08031234567",
    "code": "mtn-2gb-30days",
    "frequency": "monthly",
    "start_at": "{{startAt}}"
}'
Response
{
    "success": true,
    "message": "Schedule updated successfully.",
    "data": {
        "reference": "SCH-7F3K9QX2AB12",
        "service": "data",
        "service_label": "Internet Data",
        "biller": "mtn_data",
        "biller_label": "MTN Data",
        "biller_code": "mtn-1gb-30days",
        "product_name": "MTN 1GB - 30 Days",
        "customer_id": "08031234567",
        "customer_name": null,
        "amount": 1000,
        "frequency": "monthly",
        "frequency_label": "Monthly",
        "starts_at": "2026-11-01T09:00:00+01:00",
        "ends_at": null,
        "next_run_at": "2026-11-01T09:00:00+01:00",
        "status": "active",
        "failure_reason": null,
        "can_retry": false,
        "can_cancel": true,
        "can_pause": true,
        "can_pay_now": true,
        "can_resume": false,
        "resume_needs_start_at": false,
        "paused_at": null,
        "can_edit": true,
        "archived": false,
        "can_reactivate": false,
        "can_delete": false,
        "reactivation_needs_start_at": false,
        "cancelled_at": null,
        "total_runs": 0,
        "last_run_at": null,
        "last_run": null,
        "description": "Data for Mum",
        "summary": "Internet Data scheduled for the beneficiary 08031234567",
        "created_at": "2026-10-05T12:00:00+01:00"
    }
}