We are using cookies to improve your experience!

By clicking "Allow all", you agree to use of all cookies. Visit our Privacy Policy to learn more.

Update Recurring Schedule

PATCH /api/v1/invoices/{invoiceid}/invoicessubscription

Update the recurring schedule for an invoice’s subscription.

Path Parameters

Parameter Type Required Description
invoice_id integer Yes The unique ID of the invoice.

Request Body

Field Type Required Description
invoices_subscription[schedule] string No Updated schedule (e.g., every month).
invoices_subscription[ends_at] string (date) No Updated end date (YYYY-MM-DD).
invoices_subscription[quantity] integer No Updated number of occurrences.

Request Example

{
  "invoices_subscription": {
    "schedule": "every month",
    "ends_at": "30 Nov 2025"
  }
}
PATCH /api/v1/invoices/123/invoices_subscription HTTP/1.1
Host: koteshen.com
Authorization: Bearer {access_token}
Content-Type: application/json
Accept: application/json

{request_body}

Response

Status Codes:

  • 200 OK - Schedule updated.
  • 401 Unauthorized - Invalid or missing token.
  • 404 Not Found - Invoice or subscription not found.
  • 422 Unprocessable Entity - Invalid schedule.

Success Response (200)

Same structure as View Recurring Schedule.