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.

View Recurring Schedule

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

Retrieve the recurring subscription details for an invoice, if it exists. (Single record; no Ransack needed.)

Path Parameters

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

Request Example

GET /api/v1/invoices/123/invoices_subscription HTTP/1.1
Host: koteshen.com
Authorization: Bearer {access_token}
Content-Type: application/json
Accept: application/json

Response

Status Codes:

  • 200 OK - Subscription found.
  • 401 Unauthorized - Invalid or missing token.
  • 404 Not Found - Invoice or subscription not found.

Success Response (200)

{
  "id": 456,
  "invoice_id": 123,
  "schedule": "every month",
  "next_issue_at": "2025-11-12T00:00:00.000Z",
  "ends_at": "2025-11-30",
  "quantity": null,
  "created_at": "2025-10-21T00:00:00.000Z"
}