Get Invoice

gethttps://api.nomod.com/v1/invoices/{id}

Retrieve Invoice details by UUID.

curl -X GET 'https://api.nomod.com/v1/invoices/:id' \
  -H 'X-API-KEY: $NOMOD_API_KEY' \
  -H 'Content-Type: application/json'

Path parameters

idstring <uuid>required

Responses

idstring <uuid>requiredread-only

reference_idstringrequiredread-only

createdstring <date-time>requiredread-only

titlestringrequiredread-only

codestringrequiredread-only

urlstring <uri>requiredread-only

URL of the link or invoice,

amountstring <decimal>requiredread-only

currencystringrequired

statusobjectrequiredread-only

discountstring <decimal>requiredread-only

service_feestring <decimal>

taxstring <decimal>requiredread-only

shipping_address_requiredbooleanrequiredread-only

itemsarrayrequiredread-only

taxesarray

notestringrequiredread-only

expirystring <date-time>requiredread-only

discount_percentagestring <decimal>

service_fee_percentagestring <decimal>

tip_percentagestring <decimal>

userobjectrequired

tipstring <decimal>requiredread-only

invoice_numberstringrequiredread-only

service_datestring <date-time>requiredread-only

due_datestring <date-time>requiredread-only

interval_countintegerrequiredread-only

starts_atstring <date-time>requiredread-only

ends_atstring <date-time>requiredread-only

due_daysintegerrequiredread-only

emailstring <email>

custom_fieldsarray

sourceobjectrequiredread-only

success_urlstring <uri>

Redirects to the success URL after the invoice is completed.

failure_urlstring <uri>

Redirects to the failure URL if the invoice payment fails.

payment_capture_sourcestring

allow_tabbyboolean

allow_tamaraboolean

allow_service_feeboolean

max_allowed_charges_countinteger

filesarrayrequiredread-only

remindersarrayrequiredread-only

eventsarrayrequired

customerobjectrequiredread-only

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference_id": "string",
  "created": "2026-01-01T00:00:00Z",
  "title": "string",
  "code": "string",
  "url": "https://example.com",
  "amount": "0.00",
  "currency": "string",
  "status": {
    "0": "p",
    "1": "a",
    "2": "i",
    "3": "d"
  },
  "discount": "0.00",
  "service_fee": "0.00",
  "tax": "0.00",
  "shipping_address_required": false,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "0.00",
      "name": "string",
      "total_amount": "0.00",
      "quantity": 0,
      "sku": "string"
    }
  ],
  "taxes": [
    0
  ],
  "note": "string",
  "expiry": "2026-01-01T00:00:00Z",
  "discount_percentage": "0.00",
  "service_fee_percentage": "0.00",
  "tip_percentage": "0.00",
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "first_name": "string",
    "last_name": "string"
  },
  "tip": "0.00",
  "invoice_number": "string",
  "service_date": "2026-01-01T00:00:00Z",
  "due_date": "2026-01-01T00:00:00Z",
  "interval_count": 0,
  "starts_at": "2026-01-01T00:00:00Z",
  "ends_at": "2026-01-01T00:00:00Z",
  "due_days": 0,
  "email": "string",
  "custom_fields": [],
  "source": {
    "0": "n",
    "1": "o",
    "2": "m",
    "3": "o",
    "4": "d",
    "5": "_",
    "6": "h",
    "7": "o",
    "8": "s",
    "9": "t",
    "10": "e",
    "11": "d"
  },
  "success_url": "https://example.com",
  "failure_url": "https://example.com",
  "payment_capture_source": "string",
  "allow_tabby": false,
  "allow_tamara": false,
  "allow_service_fee": false,
  "max_allowed_charges_count": 0,
  "files": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "content_type": "string",
      "file": "https://example.com"
    }
  ],
  "reminders": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "days": 0,
      "title": "string",
      "invoice": 0,
      "run_at": "2026-01-01T00:00:00Z"
    }
  ],
  "events": [
    {
      "created": "2026-01-01T00:00:00Z",
      "type": {
        "0": "c",
        "1": "r",
        "2": "e",
        "3": "a",
        "4": "t",
        "5": "e",
        "6": "d"
      },
      "message": "string",
      "user": {
        "id": "00000000-0000-0000-0000-000000000000",
        "first_name": "string",
        "last_name": "string"
      }
    }
  ],
  "customer": {
    "first_name": "",
    "last_name": "",
    "business_name": "",
    "email": "",
    "phone_number": ""
  }
}