{
  "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": "123456",
  "description": "Payment Description",
  "created_at": "2024-01-22T05:07:31.000Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "amount": "100.00",
  "currency_id": "USD",
  "link": "https://fern.com/123456",
  "status": "ACTIVE",
  "line_items": [
    {
      "line_item_type_id": "123456",
      "item_id": "123456",
      "tax_id": "123456",
      "description": "This is a description",
      "quantity": 1,
      "unit_amount": 100,
      "line_item_type": "PAYMENT_INVOICES",
      "sub_total": 100,
      "tax_amount": 100,
      "total_amount": 100,
      "total_discount": 100,
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ]
}

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 an order.

​
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
amountstringThe amount of the Payment Link
currency_idstringThe currency of the Payment Link
linkstringThe link of the Payment Link
statusstringThe status of the Payment Link. Allowed values are ACTIVE, INACTIVE
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": "123456",
  "description": "Payment Description",
  "created_at": "2024-01-22T05:07:31.000Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "amount": "100.00",
  "currency_id": "USD",
  "link": "https://fern.com/123456",
  "status": "ACTIVE",
  "line_items": [
    {
      "line_item_type_id": "123456",
      "item_id": "123456",
      "tax_id": "123456",
      "description": "This is a description",
      "quantity": 1,
      "unit_amount": 100,
      "line_item_type": "PAYMENT_INVOICES",
      "sub_total": 100,
      "tax_amount": 100,
      "total_amount": 100,
      "total_discount": 100,
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ]
}