Skip to main content

Get List

GET 
/api/subscriptions

Get Subscriptions​

This endpoint retrieves the list of subscriptions for the authenticated user. It is useful for obtaining details about the user's active subscriptions and their statuses.

Request Parameters​

This is a GET request and does not require any specific input parameters in the query string. However, authentication headers may be required to access the user's subscription data.

Response Structure​

The response will be returned in JSON format and typically includes the following fields:

  • subscriptions: An array of subscription objects, each containing details about a specific subscription.
  • Each subscription object may include keys such as:
    • id: Unique identifier for the subscription.
    • name: The name of the subscription plan.
    • status: Current status of the subscription (e.g., active, expired).
    • start_date: The date when the subscription started.
    • end_date: The date when the subscription will expire.

Example Response​

{
  "subscriptions": [
    {
      "id": "123",
      "name": "Premium Plan",
      "status": "active",
      "start_date": "2023-01-01",
      "end_date": "2024-01-01"
    },
    ...
  ]
}

This structure allows users to easily understand their subscription details and manage their plans effectively.

Responses​