Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.invoices.link();

curl --request POST \
  --url https://api.shoply.gg/v1/stores/{storeId}/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 100,
  "description": "Logo design deposit",
  "currency": "USD",
  "uses": 1,
  "items": [
    {
      "productId": "<string>",
      "variantId": "<string>",
      "quantity": 1
    }
  ],
  "gateways": [
    "<string>"
  ],
  "expiresAt": "2026-11-30T23:59:59Z",
  "dueDays": 7
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/payment-links"

	payload := strings.NewReader("{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/payment-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/payment-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": null,
  "code": null,
  "data": {
    "orderId": "479a5h0p1ya-150cadc3a07-1006663",
    "number": 1,
    "label": "INV-0001",
    "recipientName": "",
    "note": "",
    "gateways": [
      "stripe"
    ],
    "dueAt": "2026-10-29T16:20:19Z",
    "overdue": false,
    "sentAt": null,
    "sendCount": 0,
    "dateCreated": "2026-10-22T16:20:19Z",
    "payUrl": "http://localhost:3002/checkout/479a5h0p1ya-150cadc3a07-1006663",
    "kind": "link",
    "title": "Logo design deposit",
    "uses": null,
    "linkOf": "",
    "charge": null,
    "email": "",
    "amount": 100,
    "currencyCode": "USD",
    "status": "pending",
    "itemCount": 1,
    "paidAt": null
  },
  "meta": {
    "nextNumber": "INV-0002",
    "currencyCode": "USD",
    "methods": [
      {
        "id": "stripe",
        "name": "Credit/Debit Card (Stripe)"
      }
    ],
    "sendWait": 0,
    "sendEvery": 300,
    "dueDays": {
      "min": 1,
      "max": 30,
      "default": 7
    },
    "canEmail": true,
    "linkCurrencies": [
      {
        "code": "USD",
        "name": "US dollar"
      }
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

Invoices

Create a payment link

Makes a payment link: an invoice for an amount, with no buyer on it. payUrl in the answer is the link. Whoever opens it gives their email address and pays, and the order is theirs. It is an invoice in every other way: it is listed with them, has a number and a PDF, and is cancelled if it is not paid in seven days.

A link is paid once unless uses says more. A link for more than one payment is never the order that is paid: each person who presses Pay on it is given an order and an invoice of their own, which names the link in linkOf, and the link’s uses says how many times it has been paid and how many are left. The count is asked when Pay is pressed, so two people who press it for the last use at the same moment can both pay.

It may be paid with whichever payment methods the store has switched on when it is made. It counts toward the 2,000 unpaid invoices a store may hold at once. To email it to somebody, send it (Send an invoice) with their address.

With currency, the amount is in that currency and the buyer is charged exactly it, where the store may charge in it: its own currency always, and the others only while adaptive pricing is on. The order is then for the amount’s worth in the store’s currency at the rate of the moment.

With items, the link sells products in place of an amount: it is for what they cost, in the store’s own currency, and whoever pays is sent them as any buyer is. amount and description are then left out. What it sells has to be in stock when the link is made, and again each time somebody pays through a link for several payments (out_of_stock).

It may be paid with every payment method the store has switched on, or with the ones named in gateways. It is open for seven days, or until expiresAt, or for dueDays days, up to 365.

Needs the invoices.write permission (Raise Invoices). It makes an order, and is counted against a budget of its own: 60 a minute for each key.

POST

stores

{storeId}

payment-links

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.invoices.link();

curl --request POST \
  --url https://api.shoply.gg/v1/stores/{storeId}/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 100,
  "description": "Logo design deposit",
  "currency": "USD",
  "uses": 1,
  "items": [
    {
      "productId": "<string>",
      "variantId": "<string>",
      "quantity": 1
    }
  ],
  "gateways": [
    "<string>"
  ],
  "expiresAt": "2026-11-30T23:59:59Z",
  "dueDays": 7
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/payment-links"

	payload := strings.NewReader("{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/payment-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/payment-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 100,\n  \"description\": \"Logo design deposit\",\n  \"currency\": \"USD\",\n  \"uses\": 1,\n  \"items\": [\n    {\n      \"productId\": \"<string>\",\n      \"variantId\": \"<string>\",\n      \"quantity\": 1\n    }\n  ],\n  \"gateways\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2026-11-30T23:59:59Z\",\n  \"dueDays\": 7\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": null,
  "code": null,
  "data": {
    "orderId": "479a5h0p1ya-150cadc3a07-1006663",
    "number": 1,
    "label": "INV-0001",
    "recipientName": "",
    "note": "",
    "gateways": [
      "stripe"
    ],
    "dueAt": "2026-10-29T16:20:19Z",
    "overdue": false,
    "sentAt": null,
    "sendCount": 0,
    "dateCreated": "2026-10-22T16:20:19Z",
    "payUrl": "http://localhost:3002/checkout/479a5h0p1ya-150cadc3a07-1006663",
    "kind": "link",
    "title": "Logo design deposit",
    "uses": null,
    "linkOf": "",
    "charge": null,
    "email": "",
    "amount": 100,
    "currencyCode": "USD",
    "status": "pending",
    "itemCount": 1,
    "paidAt": null
  },
  "meta": {
    "nextNumber": "INV-0002",
    "currencyCode": "USD",
    "methods": [
      {
        "id": "stripe",
        "name": "Credit/Debit Card (Stripe)"
      }
    ],
    "sendWait": 0,
    "sendEvery": 300,
    "dueDays": {
      "min": 1,
      "max": 30,
      "default": 7
    },
    "canEmail": true,
    "linkCurrencies": [
      {
        "code": "USD",
        "name": "US dollar"
      }
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

Authorizations

Authorization

string

header

required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key

string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId

string

required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Body

application/json

amount

number

How much to ask for, above zero. Left out when items is sent.

Example:

100

description

string

What it is for, up to 255 characters. The buyer sees it as the order's one line. Left out, the line is called Payment.

Example:

"Logo design deposit"

currency

string

The currency the amount is in and the buyer is charged in, as a three-letter code. Left out, the store's own.

Example:

"USD"

uses

integer

default:1

How many times the link can be paid: 1 to 1,000.

items

object[]

Products the link sells, in place of an amount: up to 50 lines.

Show child attributes

gateways

string[]

The payment methods it may be paid with, by their names in the payment methods list. Left out, every method the store has switched on.

expiresAt

string

When it stops being payable, as a date and time, or a day (YYYY-MM-DD) for the end of that day. At least an hour from now and at most 365 days.

Example:

"2026-11-30T23:59:59Z"

dueDays

integer

default:7

In place of expiresAt: how many days it is open, 1 to 365.

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object

Show child attributes