Skip to main content
PATCH
Update reusable payment link

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Path Parameters

Pattern: ^plink[A-Za-z0-9_-]{1,155}$

Query Parameters

team
string

Selected authorized team; Firebase must match current authenticated team. Mode is current persisted preference or immutable credential mode.

Body

application/json
operation_id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
expected_livemode
boolean
required
expected_revision
string
required
Pattern: ^[0-9a-f]{64}$
items
object[]
Required array length: 1 - 200 elements
currency
string
Pattern: ^[A-Z]{3}$
exchange
number | null
Required range: 1e-8 <= x <= 1000000000
description
string | null
Maximum string length: 10000
metadata
object | null
limitDaysToPay
integer | null
Required range: 1 <= x <= 3650
automations
object[]
Maximum array length: 1
custom_method_types
object[]
Maximum array length: 7

Response

Atomic durable receipt and current link.

success
enum<boolean>
required
Available options:
true
data
object
required

Current resource; null can coexist with a historical completed receipt.

operation
object
required