Skip to main content

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

The Payment Link Data Model simplifies the handling and retrieval of Payment Link data for your application. The model provides a unified representation of payment link data across different platforms, enabling you to easily access and manage payment link data from different platforms.
  • Unified Payment Link properties: The model provides a unified representation of payment link properties across different platforms, enabling you to easily access and manage payment links data from different platforms.
  • Comprehensive payment links information: The model provides a comprehensive representation of payment link data, including all the properties and relationships that you can retrieve for a payment link.

​
Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the payment link
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the payment link
platform_idstringThe Platform’s ID for the Payment Link
platform_unique_idstringThe platform’s unique identifier for the payment link
descriptionstringThe description of the Payment Link
created_atstringThe date the Payment Link was created
updated_atstringThe date the Payment Link was updated
amountnumberThe amount of the Payment Link
currency_idstringThe currency of the Payment Link
linkstringThe link of the Payment Link
statusenumThe status of the Payment Link (CREATED, PARTIALLY_PAID, PAID, CANCELLED, EXPIRED)
line_itemsLine Item[]The line items of the Payment Link

​
Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the line item
line_item_type_idstringThe ID of the parent document this line item belongs to
item_idstringThe item ID associated with the line item
tax_idstringThe tax ID associated with the line item
descriptionstringThe description of the line item
quantitynumberThe quantity of the line item
unit_amountnumberThe unit amount of the line item
line_item_typestringThe type of line item (PAYMENT_INVOICES, PAYMENT_PAYMENT_LINKS, etc.)
sub_totalnumberThe sub total of the line item
tax_amountnumberThe tax amount of the line item
total_amountnumberThe total amount of the line item
total_discountnumberThe total discount of the line item
updated_atstringThe date and time the line item was last updated

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the Payment Link
descriptionstringThe description of the Payment Link
created_atstringThe date the Payment Link was created
updated_atstringThe date the Payment Link was updated
amountnumberThe amount of the Payment Link
currency_idstringThe currency of the Payment Link
linkstringThe link of the Payment Link
statusenumThe status of the Payment Link. Allowed values are CREATED, PARTIALLY_PAID, PAID, CANCELLED, EXPIRED
line_itemsobject[]The line items of the Payment Link
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "plink_123456",
  "description": "Payment for monthly subscription",
  "created_at": "2024-01-22T05:07:31.000Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "amount": 100.00,
  "currency_id": "USD",
  "link": "https://pay.example.com/plink_123456",
  "status": "CREATED",
  "line_items": [
    {
      "platform_id": "li_123456",
      "line_item_type_id": "plink_123456",
      "item_id": "item_123",
      "tax_id": "tax_123",
      "description": "Monthly subscription fee",
      "quantity": 1,
      "unit_amount": 100.00,
      "line_item_type": "PAYMENT_PAYMENT_LINKS",
      "sub_total": 100.00,
      "tax_amount": 10.00,
      "total_amount": 110.00,
      "total_discount": 0,
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ]
}