# Subscription

The Subscription page of the Inqud Crypto Project allows you to manage and monitor your ongoing subscriptions. Subscriptions represent the recurring payment agreements between the user and the service provider, based on the authorization provided by the user. This page provides all the necessary tools to view, track, and manage these subscriptions effectively.

### **What is a Subscription?**

A subscription is a recurring payment arrangement that allows users to access services or products on a continuous basis. The subscription is established based on the user's authorization, which grants permission to charge their account according to the terms of the subscription plan.

{% hint style="info" %}
An authorization and subscription are created when a user subscribes to a subscription-type plan.
{% endhint %}

### Subscription parameters

| Parameter name | Description                                                                                         | Value (example)                                            |
| -------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| planName       | Name of plan                                                                                        | "Test plan"                                                |
| status         | Plan status                                                                                         | INITIATED, ACTIVE, CANCELLED, EXPIRED                      |
| subStatus      | Plan sub status                                                                                     | CANCELLED\_BY\_MERCHANT, CANCELLED\_PLAN, RENEWING, UNPAID |
| clientOrderId  | Merchant supplied order ID                                                                          | "order1234"                                                |
| nextWriteOfAt  | Indicates when the next recurring charge will be deducted from the user's authorized payment method | "2025-01-01T00:00:00Z"                                     |

### Subscription statuses

**INITIATED**

* **Description**: The subscription process has started but is not yet fully active.
* **Implications**:
  * The user has subscribed to the plan, and the authorization has been granted.
  * The first payment may be pending or in the process of being verified.
  * The subscription is not yet in full effect.

**ACTIVE**

* **Description**: The subscription is fully active, and recurring payments are being processed as scheduled.
* **Implications**:
  * Payments are being made according to the subscription plan's billing cycle.
  * The user has access to the services or products associated with the subscription.
  * The subscription is in good standing.
* **Sub statuses**:
  * **RENEWING**
    * Subscription is being renewed now

**CANCELLED**

* **Description**: The subscription has been terminated either by merchant, or due to unpaid dues.
* **Implications**:
  * No further payments will be processed.
  * The subscription will not renew.
  * If cancelled due to unpaid dues, the subscription is terminated because the payment could not be processed, and access to services may be revoked immediately.
  * Might be cancelled by merchant.
* **Sub statuses:**
  * **UNPAID**
    * Failed to charge user
  * **CANCELLED\_BY\_MERCHANT**
    * Merchant cancelled user subscription
  * **CANCELLED\_PLAN**
    * Merchant cancelled plan

### Subscription status transitions

<img src="https://2493659114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MVvChLJdAqFu9uz7E-7%2Fuploads%2F20069JodRq5Waz14n08j%2Ffile.excalidraw.svg?alt=media&#x26;token=b6b3d7d0-24a4-4c7e-a7dd-c57d21189e86" alt="" class="gitbook-drawing">


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.inqud.com/crypto-recurring/explore/subscription.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.