# Pause

`POST https://api.paybeta.ng/v2/scheduled-payments/scheduleReference/pause`

Authentication: `P-API-KEY` header.

Put a schedule on hold. Nothing is charged until it is resumed.

## Response 200: Success

```json
{
    "success": true,
    "message": "Schedule paused. No payments will be made until you resume it.",
    "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": null,
        "status": "paused",
        "failure_reason": null,
        "can_retry": false,
        "can_cancel": true,
        "can_pause": false,
        "can_pay_now": true,
        "can_resume": true,
        "resume_needs_start_at": false,
        "paused_at": "2026-10-05T12:30:00+01:00",
        "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"
    }
}
```
