Get subscription status (v0.0.1)

GET request that will return the current subscription status for a specific user, identified by their userId.

New version found

You are looking at a previous version of the querie Get subscription status. The latest version of this querie is v0.0.2

Overview

The GetSubscriptionStatus message is a query used to retrieve the current subscription status for a specific user, identified by their userId. This query returns detailed information about the user’s subscription, such as its current status (active, canceled, expired), the subscription tier or plan, and the next billing date. It is typically used by systems that manage user subscriptions, billing, and renewal processes to ensure that users are aware of their subscription details and any upcoming renewals.

This query is particularly useful in managing subscriptions for SaaS products, media services, or any recurring payment-based services where users need to manage and view their subscription information.

JSON Schema

userId string
required

The unique identifier for the user.

subscriptionStatus string
required

The current status of the user's subscription.

Allowed values: active canceled expired pending
subscriptionPlan string
required

The name or tier of the subscription plan.

nextBillingDate string <date-time>
required

The date and time of the next billing or renewal.

billingFrequency string
required

The frequency of the billing cycle.

Allowed values: monthly yearly
amount number
required

The amount to be billed for the subscription.

currency string
required

The currency in which the subscription is billed (e.g., USD, EUR).

lastPaymentDate string <date-time>
required

The date and time when the last payment was processed.