Skip to main content

Retrieve a recurring invoice

Retrieves a recurring invoice object.

Parameters​

No parameters.

Returns​

Returns the recurring invoice object for a valid identifier.

get
/api/recurring-invoices/{id}
curl https://{workspace}.kitchen.co/api/recurring-invoices/{id} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "amount": 675.65,
  "billing_profile": {
    "address": "93175 Salvador Isle",
    "city": "South Cheyenneburgh",
    "company_name": null,
    "country": "RU",
    "email": "mcclure.sean@example.com",
    "id": "bp_0123bc88a70c86ed9d1feb73",
    "name": "Georgianna Heidenreich",
    "phone": "563-497-7493",
    "state": "Robertsshire",
    "updated_at": "2024-03-13T09:16:53+00:00",
    "vat_id": null,
    "zip": "66992-3386"
  },
  "charge_automatically": false,
  "client": {
    "created_at": "2024-03-13T09:16:53+00:00",
    "email": "considine.libby@example.org",
    "group": "client",
    "id": "u_62988d0392da49247a831d35",
    "language": null,
    "name": "Mozell Denesik",
    "phone": null,
    "role": "member",
    "timezone": null,
    "title": null,
    "updated_at": "2024-03-13T09:16:53+00:00",
    "username": "legros.tracy"
  },
  "created_at": "2024-03-13T09:16:53+00:00",
  "creator": {
    "created_at": "2024-03-13T09:16:53+00:00",
    "email": "norris.oberbrunner@example.net",
    "group": "client",
    "id": "u_c13cc0aee4b5af7a42951898",
    "language": null,
    "name": "Dr. Harmon Kautzer",
    "phone": null,
    "role": "member",
    "timezone": null,
    "title": null,
    "updated_at": "2024-03-13T09:16:53+00:00",
    "username": "jalon98"
  },
  "currency": "USD",
  "discount_amount": 341.47,
  "discounts": [
    {
      "amount": 50.54,
      "currency": "USD",
      "id": "invti_81c4288ef04117d38e29b22c",
      "title": "The discount item title",
      "type": "percentage"
    }
  ],
  "due_date_in_days": 8,
  "due_reminder_message": "The reminder message",
  "due_reminder_send_days": 2,
  "footer_notes": null,
  "id": "in_700e2b6deea32f7022cc3cc9",
  "items": [
    {
      "amount": 675.65,
      "currency": "USD",
      "description": "The invoice item description",
      "id": "invi_ac3074df0d1c309d12624399",
      "quantity": "1.00",
      "title": "The invoice item title"
    }
  ],
  "language": "en_US",
  "memo": null,
  "next_invoice_issue_date": null,
  "payment_gateways": [],
  "recurring_activated_at": null,
  "recurring_end_date": null,
  "recurring_frequency": 1,
  "recurring_name": "Recurring #1",
  "recurring_period_unit": "month",
  "recurring_send_email_cc_addresses": null,
  "recurring_send_email_message": null,
  "recurring_send_email_to_client": null,
  "recurring_send_to_conversation": null,
  "recurring_start_date": null,
  "recurring_status": "draft",
  "recurring_stopped_at": null,
  "target_folder": null,
  "tax_items": [
    {
      "amount": 46.3,
      "currency": "USD",
      "id": "invti_e5d2b8e5d9a4017b84c95b47",
      "title": "The tax item title"
    }
  ],
  "tax_amount": 154.73,
  "total_amount": 488.91,
  "type": "recurring",
  "updated_at": "2024-03-13T09:16:53+00:00"
}