> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/2026-05/payment_links/object.md). # The payment link object A comprehensive list of the payment link resource's attributes and relationships A payment link object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/2026-05/payment_links` endpoint. ## Fields | Field | Type | Description | | ---------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `payment_links` | | **id** | `string` | The payment link unique identifier | | links.**self** | `string` | The payment link endpoint URL | | attributes.**status** | `string` | The payment link status. One of 'open' (default), 'expired', or 'completed'. | | attributes.**amount\_cents** | `integer` | The payment link amount to collect, in cents. Defaults to the associated payment session amount, or to the order outstanding amount when no session is present. Not updatable once the payment link is created. | | attributes.**amount\_float** | `float` | The payment link amount, float. | | attributes.**formatted\_amount** | `string` | The payment link amount, formatted. | | attributes.**currency\_code** | `string` | The international 3-letter currency code as defined by the ISO 4217 standard. Defaults to the associated payment session or order currency code. | | attributes.**name** | `string` | An optional name for the payment link, shown on the gateway's hosted page when supported. Not updatable once the payment link is created. | | attributes.**token** | `string` | The unique token identifying the payment link. | | attributes.**url** | `string` | The URL for this payment link returned by the gateway. | | attributes.**return\_url** | `string` | The URL to redirect your customer upon payment is completed. When omitted, the customer stays on the gateway's hosted page once the payment is completed. | | attributes.**options** | `object` | Options to use for the payment link, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels. | | attributes.**request\_data** | `object` | The data of the request sent to the payment gateway. | | attributes.**response\_data** | `object` | The payment gateway response data, used by successive payment workflows. | | attributes.**\_internal\_version** | `string` | Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal\_versionable. | | attributes.**\_refresh** | `boolean` | Send this attribute if you want to sync the payment link status with the payment gateway. | | attributes.**\_cancel** | `boolean` | Send this attribute if you want to cancel this payment link. Cannot be passed by sales channels. | | attributes.**completed\_at** | `string` | Time at which the payment link has been expired. | | attributes.**expired\_at** | `string` | Time at which the payment link has been expired. | | attributes.**created\_at** | `string` | Time at which the resource was created. | | attributes.**updated\_at** | `string` | Time at which the resource was last updated. | | attributes.**reference** | `string` | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. | | attributes.**reference\_origin** | `string` | Any identifier of the third party system that defines the reference code. | | attributes.**metadata** | `object` | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. | | relationships.**order** | `object` | The associated order. | | relationships.**billing\_address** | `object` | The associated billing address. Inherited from the associated order's own billing address when not specified. Required by Checkout.com. | | relationships.**payment\_setting** | `object` | The associated payment setting. | | relationships.**payment\_session** | `object` | The associated payment session. Required by the payment settings that need a session token to build the link, optional otherwise. | | relationships.**attachments** | `array` | The associated attachments. | | relationships.**events** | `array` | The associated events. | | relationships.**event\_stores** | `array` | The associated event stores. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.commercelayer.io/core-api-reference/2026-05/payment_links/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.