The Payment Link object
A payment link is a shareable URL that takes your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer opens a payment link, Zoneless creates a new Checkout Session to render the payment page. Use Checkout Session events such as checkout.session.completed to track payments made through payment links.
Attributes
id string Unique identifier for the object. Zoneless Payment Link IDs are prefixed with plink_z_.
object string String representing the object's type. Objects of the same type share the same value.
active boolean Whether the payment link's url is active. If false, customers visiting the URL see a page saying that the link has been deactivated.
after_completion object Behavior after the purchase is complete.
allow_promotion_codes boolean Whether user redeemable promotion codes are enabled.
currency string Three-letter ISO currency code, in lowercase. For Zoneless, this is usdc.
Difference from Stripe: Zoneless settles in USDC on Solana rather than fiat currencies.
line_itemsnullable object The line items representing what is being sold. Expand this field with the expand request parameter, or retrieve them with the line items endpoint.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata object Set of key-value pairs that you can attach to an object. Useful for storing additional information in a structured format.
payment_method_typesnullable array of strings The list of payment method types that customers can use. When null, relevant payment methods enabled in your payment method settings are shown dynamically.
Difference from Stripe: Zoneless currently accepts crypto (USDC on Solana) rather than cards or other fiat rails.
url string The public URL that can be shared with customers.
platform_account string The platform account that owns this resource. For connected account resources, this is the platform's account ID. For the platform's own resources, this equals the account field (self-referential).
Zoneless extension: This field is not present in Stripe's API. It enables multi-tenant operation.
url_slug string Opaque slug used in the public payment link URL (/b/{url_slug}). Distinct from id so shareable links do not expose the API object ID.
Zoneless extension: This field is not present in Stripe's API.
More attributes
{
"id": "plink_z_7nQ2wKpR9xVmHc4bYtLsJ8fA",
"object": "payment_link",
"active": true,
"created": 1725123600,
"after_completion": {
"hosted_confirmation": {
"custom_message": null
},
"redirect": null,
"type": "hosted_confirmation"
},
"allow_promotion_codes": false,
"application": null,
"application_fee_amount": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false,
"liability": null
},
"billing_address_collection": "auto",
"consent_collection": null,
"currency": "usdc",
"custom_fields": [],
"custom_text": {
"after_submit": null,
"shipping_address": null,
"submit": null,
"terms_of_service_acceptance": null
},
"customer_creation": "if_required",
"inactive_message": null,
"invoice_creation": {
"enabled": false,
"invoice_data": {
"account_tax_ids": null,
"custom_fields": null,
"description": null,
"footer": null,
"issuer": null,
"metadata": {},
"rendering_options": null
}
},
"livemode": false,
"managed_payments": null,
"metadata": {},
"name_collection": null,
"on_behalf_of": null,
"optional_items": null,
"payment_intent_data": null,
"payment_method_collection": "always",
"payment_method_options": null,
"payment_method_types": [
"crypto"
],
"phone_number_collection": {
"enabled": false
},
"restrictions": null,
"shipping_address_collection": null,
"shipping_options": [],
"submit_type": "auto",
"subscription_data": null,
"tax_id_collection": {
"enabled": false
},
"transfer_data": null,
"url": "https://pay.yourdomain.com/b/n4k8m2p7q1",
"url_slug": "n4k8m2p7q1",
"platform_account": "acct_z_Platform123abc"
}