Payment schedule

See what a subscription will charge and when; add, edit or cancel items.

The payment schedule is the list of upcoming (and past) charges for a subscription. PayChoice generates it from the membership; you can add one-off items, move or re-price an item, or cancel one.

Action	Request
List	GET /subscription/{subscription}/paymentschedule — not paginated
Retrieve	GET /subscription/{subscription}/paymentschedule/{item}
Add item	POST /subscription/{subscription}/paymentschedule with amount and date_scheduled
Edit item	PATCH /subscription/{subscription}/paymentschedule/{item} — amount and/or date_scheduled
Cancel item	DELETE /subscription/{subscription}/paymentschedule/{item}

{
  "status": "Success",
  "code": 200,
  "messages": [ { "message_text": "Data Selected", "message_type": "success" } ],
  "payment_schedule_list": [
    {
      "id": "b9d3a6e2-5f71-4c84-8e05-3a1d7c9f2b58",
      "reference_id": 825,
      "payment_type": "Setup Fee Payment",
      "amount": "99.00",
      "date_scheduled": "2026-11-10",
      "invoiced": true,
      "subscription_id": "6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46",
      "status": "Paid Payment",
      "link": { "href": "/api/v4/subscription/6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46/paymentschedule/b9d3a6e2-5f71-4c84-8e05-3a1d7c9f2b58", "rel": "self" }
    },
    {
      "id": "c2e7f4a9-1d58-4b36-9a72-8e0c5d3f6b19",
      "reference_id": 827,
      "payment_type": "Subscription Payment",
      "amount": "48.00",
      "date_scheduled": "2026-12-10",
      "invoiced": false,
      "subscription_id": "6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46",
      "status": "Scheduled",
      "link": { "href": "/api/v4/subscription/6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46/paymentschedule/c2e7f4a9-1d58-4b36-9a72-8e0c5d3f6b19", "rel": "self" }
    }
  ],
  "object_type": "payment_schedule_list",
  "link": { "href": "/api/v4/subscription/6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46/paymentschedule", "rel": "self" }
}

id · uuid

The item ID.

payment_type · string

Setup Fee Payment, Trial Payment, Subscription Payment, Schedule Payment (items you add), Suspension Payment, Cancellation Payment, UFN Payment or Dishonour Fee Payment.

amount · string

Decimal.

date_scheduled · date

YYYY-MM-DD.

invoiced · boolean

false while Scheduled; true once an invoice has been raised.

status · string

Scheduled, Void, Paid Cash, Suspension, Cancelled, Dishonour, Processing Payment, Paid Payment, Refund Processing or Has Been Refunded.

Add a one-off item

curl https://api-sandbox.paychoice.com.au/api/v4/subscription/6d1f8b2a-4c73-4e95-b8a0-2f9e7c1d3b46/paymentschedule \
  -u "$PAYCHOICE_USERNAME:$PAYCHOICE_PASSWORD" \
  -H "Accept: application/json" \
  -d amount=50 -d date_scheduled=2026-11-22

The item is created as a Schedule Payment with status Scheduled. Edit returns the updated item; Cancel returns it with status Cancelled.