Get Link

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

Retrieve link details by Id.

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

Path parameters

idstring <uuid>required

Responses

payment_block_reasonstringread-only

Currency-only payment block reason. currency_unavailable means the link or invoice is open for payment but its currency is inactive. null means no currency block applies, including objects whose checkout status is already closed. It is not a guarantee that other payment eligibility checks pass. The existing status, currency and amounts are unchanged.

Enum: currency_unavailable, null

idstring <uuid>requiredread-only

reference_idstringrequiredread-only

titlestringrequiredread-only

urlstring <uri>requiredread-only

amountstring <decimal>requiredread-only

currencystringrequired

statusobjectrequiredread-only

discountstring <decimal>requiredread-only

service_feestring <decimal>requiredread-only

allow_tipbooleanrequiredread-only

shipping_address_requiredbooleanrequiredread-only

itemsarrayrequired

taxstring <decimal>requiredread-only

notestringrequiredread-only

taxesarrayrequiredread-only

discount_percentageintegerrequiredread-only

service_fee_percentagestring <decimal>requiredread-only

tipstring <decimal>requiredread-only

tip_percentageintegerrequiredread-only

due_datestring <date-time>requiredread-only

custom_fieldsarrayrequiredread-only

sourceobjectrequiredread-only

allow_tabbybooleanrequiredread-only

allow_tamarabooleanrequiredread-only

allow_service_feebooleanrequiredread-only

payment_expiry_limitintegerrequiredread-only

expiry_datestring <date>requiredread-only

Example response

{
  "payment_block_reason": "currency_unavailable",
  "id": "00000000-0000-0000-0000-000000000000",
  "reference_id": "string",
  "title": "string",
  "url": "https://example.com",
  "amount": "0.00",
  "currency": "string",
  "status": "enabled",
  "discount": "0.00",
  "service_fee": "0.00",
  "allow_tip": false,
  "shipping_address_required": false,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "0.00",
      "name": "string",
      "total_amount": "0.00",
      "quantity": 0,
      "sku": "string"
    }
  ],
  "tax": "0.00",
  "note": "string",
  "taxes": [
    {
      "name": "string",
      "mode": "string",
      "mode_value": "0.000",
      "value": "0.000"
    }
  ],
  "discount_percentage": 0,
  "service_fee_percentage": "0.00",
  "tip": "0.00",
  "tip_percentage": 0,
  "due_date": "2026-01-01T00:00:00Z",
  "custom_fields": [
    {
      "name": "string",
      "is_required": false
    }
  ],
  "source": "nomod_hosted",
  "allow_tabby": false,
  "allow_tamara": false,
  "allow_service_fee": false,
  "payment_expiry_limit": 0,
  "expiry_date": "2026-01-01"
}