Get a pay-me page

GET/v1/public/pay-me/{slug}

Coming February 2027

This endpoint ships in February 2027. The shape shown here can still change before release.

Returns a business's public pay-me page: its name, logo and every enabled way to pay.

Backs freeinvoiceautomation.com/<business-slug>, where anyone can pay the business without an invoice link, and the WordPress [fia_pay_me] block. The page has no analytics. See Pay-me page.

Permission: none
Type: Read-only. Changes nothing.
Auth: None (public, rate limited per IP)
Capability: get_pay_me_page_public
Available: From February 2027

get_pay_me_page_public

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/public/pay-me/<slug>

{
  "data": {
    "business": {
      "display_name": "Studio North",
      "logo_url": "https://files.freeinvoiceautomation.com/signed/logo.png?sig=..."
    },
    "headline": "Pay Studio North",
    "description": "Card or bank transfer.",
    "allow_custom_amount": true,
    "rails": [
      {
        "connection_id": "0193f2c0-4b5c-7d6e-8f70-1a2b3c4d5e6f",
        "rail": "stripe",
        "instructions": null
      },
      {
        "connection_id": "0193f2c0-4b5c-7d6e-8f70-1a2b3c4d5e70",
        "rail": "bank_transfer",
        "instructions": {
          "text": "IBAN PT50 0000 0000 0000 0000 0000 0"
        }
      }
    ]
  }
}

Path Parameters

slugstringrequired

The business's slug.

Response

200 - application/json

businessobject

Business name and logo.

headlinestring | null

Headline the business set for the page.

descriptionstring | null

Text the business set for the page.

allow_custom_amountboolean

Whether the payer can enter their own amount (proposed).

railsobject[]

Enabled ways to pay.

Errors

not_found

rate_limited

Plus the common errors every call can return. See Errors.

Suggest edits Raise issue

Open a portal sessionPrevious Opt out of remindersNext

get_pay_me_page_public

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/public/pay-me/<slug>

{
  "data": {
    "business": {
      "display_name": "Studio North",
      "logo_url": "https://files.freeinvoiceautomation.com/signed/logo.png?sig=..."
    },
    "headline": "Pay Studio North",
    "description": "Card or bank transfer.",
    "allow_custom_amount": true,
    "rails": [
      {
        "connection_id": "0193f2c0-4b5c-7d6e-8f70-1a2b3c4d5e6f",
        "rail": "stripe",
        "instructions": null
      },
      {
        "connection_id": "0193f2c0-4b5c-7d6e-8f70-1a2b3c4d5e70",
        "rail": "bank_transfer",
        "instructions": {
          "text": "IBAN PT50 0000 0000 0000 0000 0000 0"
        }
      }
    ]
  }
}