> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subotiz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Object

Subscription entity field reference.

| Field                  | Type               | Desc                                                                                                                                                                                                                                  |
| ---------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                     | string             | Subscription unique identifier                                                                                                                                                                                                        |
| customer\_id           | string             | Subotiz customer unique identifier                                                                                                                                                                                                    |
| email                  | string             | Customer email                                                                                                                                                                                                                        |
| cycle\_index           | int                | Current cycle index of the subscription                                                                                                                                                                                               |
| metadata               | map\[string]string | A set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.                                                                                                      |
| cancel\_reason         | string             | Cancel subscription reason                                                                                                                                                                                                            |
| sub\_merchant\_id      | string             | Merchant unique identifier                                                                                                                                                                                                            |
| status                 | string             | Subscription business status:<br />init - Pending activation<br />trial - Trial period<br />active - Active<br />paused - Paused<br />past\_due - Past due<br />unpaid - Unpaid<br />canceled - Canceled<br />incomplete - Incomplete |
| price\_id              | string             | Product pricing plan unique identifier                                                                                                                                                                                                |
| total\_cycles          | int                | Total number of cycles (0 means unlimited)                                                                                                                                                                                            |
| current\_period\_start | string             | Current billing period start time                                                                                                                                                                                                     |
| current\_period\_end   | string             | Current billing period end time                                                                                                                                                                                                       |
| next\_invoice\_date    | string             | Next renewal time                                                                                                                                                                                                                     |
| created\_at            | string             | Creation time                                                                                                                                                                                                                         |
| updated\_at            | string             | Update time                                                                                                                                                                                                                           |
| cancel\_at             | string             | Cancel subscription time (optional)                                                                                                                                                                                                   |
| order\_id              | string             | Third-party order ID, same as the `order_id` passed when creating checkout session.                                                                                                                                                   |
| source\_trade\_id      | string             | Trade ID, subscription originated from this trade order.                                                                                                                                                                              |
| price\_type            | string             | Price Type                                                                                                                                                                                                                            |
| price\_version\_id     | string             | Product pricing plan version unique identifier                                                                                                                                                                                        |
| first\_source\_channel | string             | The source where this checkout session was initially created                                                                                                                                                                          |
| last\_source\_channel  | string             | The source where this checkout session was last accessed                                                                                                                                                                              |
| fixed\_term            | string             | Number of fixed-term periods. `"0"` indicates an ongoing subscription (no fixed term)                                                                                                                                                 |
| is\_renewable          | bool               | Whether the subscription automatically converts to an ongoing subscription upon expiration                                                                                                                                            |
| end\_at                | string             | Subscription end time. An empty string indicates an ongoing subscription (no end time)                                                                                                                                                |
| current\_period        | int                | Current period number of the subscription                                                                                                                                                                                             |
| is\_canceling          | bool               | Whether the subscription is pending cancellation                                                                                                                                                                                      |
| launch\_cancel\_at     | string             | The time when the cancellation was initiated                                                                                                                                                                                          |
| expected\_cancel\_at   | string             | The expected date of subscription cancellation                                                                                                                                                                                        |