Get a payment run

Gets details about a particular payment run based on a payment run id in Advanced Payment Manager.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request
path Parameters
payment_run_id
required
integer

The payment run ID. A payment run id in Advanced Payment Manager is different from a payment run id in Zuora.

Responses
200
get/api/v1/subscription_payment_runs/{payment_run_id}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "id": 6,
  • "status": "Complete",
  • "target_date": "2018-01-02",
  • "filter": "Account.Currency = 'CAD'",
  • "payment_run_schedule_id": "Adhoc",
  • "invoices_held": { },
  • "metrics": {
    }
}