Skip to main content
The Subscriptions Data Model simplifies the handling and retrieval of Subscriptions data for your application. The model provides a unified representation of subscriptions data across different platforms, enabling you to easily access and manage subscriptions data from different platforms.
  • Unified Subscriptions properties: The model provides a unified representation of subscriptions properties across different platforms, enabling you to easily access and manage subscriptions data from different platforms.
  • Comprehensive subscriptions information: The model provides a comprehensive representation of subscriptions data, including all the properties and relationships that you can retrieve for a subscription.

​
Attributes

​
Subscription Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the subscription
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 subscription
platform_idstringThe Platform’s ID for the Subscription
platform_unique_idstringThe platform’s unique identifier for the subscription
created_atstringThe date and time the Subscription was created
currency_idstringThe currency ID of the Subscription
descriptionstringThe description of the Subscription
statusstringThe status of the Subscription
contact_idstringThe contact ID of the Subscription
expire_bystringThe expiry date of the Subscription
current_startstringThe current billing period start date of the Subscription
current_endstringThe current billing period end date of the Subscription
payment_methodstringThe payment method of the Subscription

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the Subscription
created_atstringThe date and time the Subscription was created
currency_idstringThe currency ID of the Subscription
descriptionstringThe description of the Subscription
statusstringThe status of the Subscription
contact_idstringThe contact ID of the Subscription
expire_bystringThe expiry date of the Subscription
current_startstringThe current billing period start date of the Subscription
current_endstringThe current billing period end date of the Subscription
payment_methodstringThe payment method of the Subscription
{
  "rootfi_id": 157,
  "rootfi_deleted_at": null,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "sub_123456",
  "created_at": "2024-01-22T05:07:31.465Z",
  "currency_id": "USD",
  "description": "Premium monthly subscription",
  "status": "ACTIVE",
  "contact_id": "cus_123456",
  "expire_by": "2025-01-22T05:07:31.465Z",
  "current_start": "2024-01-22T05:07:31.465Z",
  "current_end": "2024-02-22T05:07:31.465Z",
  "payment_method": "CARD"
}