POST
/
v1
/
links
curl --request POST \
  --url https://api.nomod.com/v1/links \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "currency": "<string>",
  "items": [
    {
      "name": "<string>",
      "amount": "<string>",
      "quantity": 500
    }
  ],
  "title": "<string>",
  "note": "<string>",
  "discount_percentage": 0,
  "shipping_address_required": false,
  "allow_tip": false,
  "custom_fields": [
    {
      "name": "<string>"
    }
  ],
  "success_url": "<string>",
  "failure_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "status": "enabled",
  "discount": "<string>",
  "service_fee": "<string>",
  "allow_tip": true,
  "shipping_address_required": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "name": "<string>",
      "total_amount": "<string>",
      "quantity": 2147483647,
      "sku": "<string>"
    }
  ],
  "tax": "<string>",
  "note": "<string>",
  "taxes": [
    {
      "name": "<string>",
      "mode": "<string>",
      "mode_value": "0.000",
      "value": "0.000"
    }
  ],
  "discount_percentage": 123,
  "service_fee_percentage": "<string>",
  "tip": "<string>",
  "tip_percentage": 123,
  "custom_fields": [
    {
      "name": "<string>",
      "is_required": true
    }
  ],
  "source": "woocommerce",
  "pages_url": "<string>"
}

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

Body

application/json

Response

201
application/json

The response is of type object.