The object is everything inside data. The field names below are relative to it: attributes.proposedAgents is data.attributes.proposedAgents in the response.
Fields
string
required
Resource type. Always invitationLink.
string
required
Invitation link ID (ivl_*).
object
required
The link’s details.
Hide attributes
object[]
required
Agents offered to customers who open this link.
Hide proposedAgents
string
required
Agent ID (agt_*).
string[]
required
Permissions granted to this agent when a customer approves. Each item is one of: disputes.read, disputes.create, payments.read, payments.create, externalParties.read, externalParties.create, direct.read, direct.create, externalAccounts.create, wallets.read, wallets.balance, wallets.create, wallets.update, wallets.fund, wallets.deposit, wallets.transfer, wallets.withdraw, party.read, party.update, paymentIntents.create, paymentIntents.read, cardPayments.read, refunds.read, refunds.create, voiceSessions.read, voiceSessions.create, chargebacks.read, chargebacks.respond, mandates.read, enrollment.read, cards.read, savedCards.use, paymentRequests.read, paymentRequests.create, externalAccounts.read.
object | null
required
Proposed per-transaction limit, or null when no limit is offered.
Hide limits
integer
required
Per-transaction limit in cents.
string
required
Link status. One of: active, revoked. See Statuses.
string
required
RFC 3339 timestamp when this link was created.
string
required
Label for this link.
string | null
required
RFC 3339 timestamp when this link stops accepting new customers, or null when it never expires.
object
required
Metadata visible to anyone who can read the resource.
string
required
Link token with all but the last 4 characters masked (for example ***bc4d). The full token and URL are returned only when the link is created.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that created this link.
Hide developerParty
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
Statuses
Status
Meaning
Can become
active
Customers who open the link can accept it. A link past expiresAt stays active but connects no one.
revoked
revoked
The link connects no new customers. Customers it already connected keep their access.
Final
Events
invitationLink.created: A reusable invitation link was created with its initial offered agents.
invitationLink.revoked: An invitation link was revoked and its open offers were withdrawn.