> ## 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.

# Overview

> Subscriptions are a way to manage recurring payments for your customers. The Subscriptions Data Model simplifies the handling and retrieval of Subscriptions data for your application.

**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

| Property             | Type    | Description                                                           |
| -------------------- | ------- | --------------------------------------------------------------------- |
| rootfi\_id           | integer | The RootFi ID of the subscription                                     |
| rootfi\_created\_at  | string  | The ISO 8601 timestamp at which the record was created in RootFi      |
| rootfi\_updated\_at  | string  | The ISO 8601 timestamp at which the record was last updated in RootFi |
| rootfi\_company\_id  | integer | The RootFi company ID associated with the subscription                |
| platform\_id         | string  | The Platform's ID for the Subscription                                |
| platform\_unique\_id | string  | The platform's unique identifier for the subscription                 |
| created\_at          | string  | The date and time the Subscription was created                        |
| currency\_id         | string  | The currency ID of the Subscription                                   |
| description          | string  | The description of the Subscription                                   |
| status               | string  | The status of the Subscription                                        |
| contact\_id          | string  | The contact ID of the Subscription                                    |
| expire\_by           | string  | The expiry date of the Subscription                                   |
| current\_start       | string  | The current billing period start date of the Subscription             |
| current\_end         | string  | The current billing period end date of the Subscription               |
| payment\_method      | string  | The payment method of the Subscription                                |

## Properties Supported

| Property        | Type   | Description                                               |
| --------------- | ------ | --------------------------------------------------------- |
| platform\_id    | string | The Platform's ID for the Subscription                    |
| created\_at     | string | The date and time the Subscription was created            |
| currency\_id    | string | The currency ID of the Subscription                       |
| description     | string | The description of the Subscription                       |
| status          | string | The status of the Subscription                            |
| contact\_id     | string | The contact ID of the Subscription                        |
| expire\_by      | string | The expiry date of the Subscription                       |
| current\_start  | string | The current billing period start date of the Subscription |
| current\_end    | string | The current billing period end date of the Subscription   |
| payment\_method | string | The payment method of the Subscription                    |

<ResponseExample name="The Subscriptions Object">
  ```json The Subscriptions Response Object theme={null}
  {
    "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"
  }
  ```
</ResponseExample>