GetbeelDocs

Create a Stripe payment link

A Stripe payment link for what is still due, on the team's connected Stripe account (Stripe Connect). Returns the existing link (200) when the invoice has one. Invoice emails and reminders include it while the invoice is unpaid; payments made through it are recorded within the hour. Sandbox invoices need a Stripe test-mode connection.

POST
/invoices/{id}/payment-link

A Stripe payment link for what is still due, on the team's connected Stripe account (Stripe Connect). Returns the existing link (200) when the invoice has one. Invoice emails and reminders include it while the invoice is unpaid; payments made through it are recorded within the hour. Sandbox invoices need a Stripe test-mode connection.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Recommended. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body returns 422 idempotency_key_reused.

Lengthlength <= 255
Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid

Response Body

The invoice already had a link

application/json
  1. response
object*string
id*string
invoice_id*string
url*string
amount*string

Decimal amount as a string

Match^-?\d+\.\d{2}$
currency*string
created*boolean

false when the invoice already had a link (returned as is)

Example Request
curl -X POST 'https://www.getbeel.com/api/v1/invoices/string/payment-link'
Example Response
{  "object": "payment_link",  "id": "plink_1Q…",  "invoice_id": "string",  "url": "string",  "amount": "122.00",  "currency": "string",  "created": true}