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

# Trialing

> This event is triggered when a subscription enters the trialing state—before it becomes fully active. It indicates the start of the trial period, during which the user can access the subscription benefits without being charged. The event includes details such as the subscription ID, upcoming payment date, remaining billing cycles, and optional metadata.

<ResponseExample>
  ```json theme={null}
  {
    "eventId": "whe_fooD944t4VUKkaDT",
    "eventType": "subscription.trialing",
    "eventTime": 1729608043615,
    "subscriptionId": "sub_fooBOwYsaK50AEfK",
    "nextPaymentDate": 1729694400000,
    "remainingCycleCount": 5,
    "metadata": { 
      "orderId": "12345",
      "customerNote": "Deliver after 5 PM" 
    }
  }
  ```
</ResponseExample>

<ResponseField name="eventId" type="string">
  {" "}

  A unique identifier for this specific event. This ensures that each event can be
  tracked and processed individually.{" "}
</ResponseField>

<ResponseField name="eventType" type="string">
  {" "}

  Describes the type of event. In this case, it signifies that a subscription has
  entered the trialing state.{" "}
</ResponseField>

<ResponseField name="eventTime" type="integer">
  {" "}

  The timestamp when the event was generated, typically in milliseconds since the
  Unix epoch (January 1, 1970). This value can be used to track when the event occurred.{" "}
</ResponseField>

<ResponseField name="subscriptionId" type="string">
  {" "}

  A unique identifier for the specific subscription that transitioned to the active
  state.{" "}
</ResponseField>

<ResponseField name="nextPaymentDate" type="integer">
  {" "}

  A timestamp indicating the date and time of the next scheduled payment, expressed
  in milliseconds since the Unix epoch.{" "}
</ResponseField>

<ResponseField name="remainingCycleCount" type="integer">
  {" "}

  The number of billing cycles remaining for the subscription. For example, if the
  total cycle count is 6 and 1 cycle has been completed, the remaining cycle count
  will be `5`.{" "}
</ResponseField>

<ResponseField name="metadata" type="object">
  A collection of key-value pairs that were provided when the object was
  created. These metadata values are echoed back in the response, allowing you
  to store and retrieve custom information such as context-specific attributes,
  references, or tags. This can be useful for correlating records in your system
  or attaching meaningful context to transactions.
</ResponseField>
