GET
/
v1
/
invoices
/
{uuid}
curl --request GET \
  --url https://api.nomod.com/v1/invoices/{uuid} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "code": "<string>",
  "url": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "status": "paid",
  "discount": "<string>",
  "service_fee": "<string>",
  "tax": "<string>",
  "shipping_address_required": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "name": "<string>",
      "total_amount": "<string>",
      "quantity": 2147483647,
      "sku": "<string>"
    }
  ],
  "note": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "discount_percentage": "<string>",
  "service_fee_percentage": "<string>",
  "tip_percentage": "<string>",
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "tip": "<string>",
  "invoice_number": "<string>",
  "service_date": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "interval_count": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "due_days": 123,
  "custom_fields": [],
  "source": "woocommerce",
  "success_url": "<string>",
  "failure_url": "<string>",
  "files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "content_type": "<string>",
      "file": "<string>"
    }
  ],
  "reminders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "days": 123,
      "title": "<string>",
      "invoice": 123,
      "run_at": "2023-11-07T05:31:56Z"
    }
  ],
  "events": [
    {
      "created": "2023-11-07T05:31:56Z",
      "type": "created",
      "message": "<string>",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>"
      }
    }
  ],
  "customer": {}
}

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Path Parameters

​
uuid
string
required

Response

200
application/json
​
id
string
required
​
reference_id
string
required
​
created
string
required
​
title
string
required
​
code
string
required
​
url
string
required

URL of the link or invoice,

​
amount
string
required
​
currency
string
required
​
status
enum<string>
required
  • paid - paid
  • unpaid - unpaid
  • overdue - overdue
  • cancelled - cancelled
  • scheduled - scheduled
Available options:
paid,
unpaid,
overdue,
cancelled,
scheduled
​
discount
string
required
​
service_fee
string
required
​
tax
string
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
note
string
required
​
expiry
string
required
​
user
object
required
​
tip
string
required
​
invoice_number
string
required
​
service_date
string
required
​
due_date
string
required
​
interval_count
integer
required
​
starts_at
string
required
​
ends_at
string
required
​
due_days
integer
required
​
source
enum<string>
required
  • woocommerce - WooCommerce
  • zapier - Zapier
  • nomod_api - API
  • pages - Pages
  • app - App
  • web - Web
Available options:
woocommerce,
zapier,
nomod_api,
pages,
app,
web
​
files
object[]
required
​
reminders
object[]
required
​
events
object[]
required
​
customer
object
required
​
discount_percentage
string | null
​
service_fee_percentage
string | null
​
tip_percentage
string | null
​
custom_fields
object[]
​
success_url
string

Redirects to the success URL after the invoice is completed.

​
failure_url
string

Redirects to the failure URL if the invoice payment fails.

Create InvoiceUpdate Invoice