Skip to main content
GET
Get My Subscription
Retrieve the current authenticated user’s active subscription for the project. Use this to display subscription status in your application.

Authentication

This endpoint requires end user authentication via HTTP Bearer Token with project scope.

Query Parameters

test_mode
boolean
default:"true"
Use test mode data. Set to false for production subscriptions.

Response

Returns the subscription object if active, or null if no subscription exists.
id
string (UUID)
Internal subscription record ID
project_id
string (UUID)
Project the subscription belongs to
user_id
string (UUID)
User who owns the subscription
is_test_mode
boolean
Whether this is a test mode subscription
subscription_id
string
Stripe subscription ID (e.g., sub_ABC123)
customer_id
string
Stripe customer ID
status
string
Subscription status: active, trialing, past_due, canceled, incomplete
plan_name
string
Name of the subscribed plan
quantity
integer
Number of subscription seats/units
current_period_start
datetime
Start of current billing period
current_period_end
datetime
End of current billing period (renewal date)
cancel_at
datetime
Scheduled cancellation date (if set)
cancelled_at
datetime
When cancellation was requested
created_at
datetime
When subscription was created

Example Request

Example Response

Active Subscription

No Subscription

Subscription Status Flow

Integration Example

Common Use Cases

Error Responses

Create Checkout

Start a new subscription

Cancel Subscription

Cancel user’s subscription

Update Subscription

Change subscription plan

Customer Portal

Let user manage billing

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

test_mode
boolean
default:true

Use test mode

Response

StripeSubscriptionResponse · object | null

Successful Response

Stripe subscription details.

id
string<uuid>
required
project_id
string<uuid>
required
is_test_mode
boolean
required
subscription_id
string
required
status
string
required
quantity
integer
required
created_at
string<date-time>
required
user_id
string<uuid> | null
customer_id
string | null
plan_name
string | null
current_period_start
string<date-time> | null
current_period_end
string<date-time> | null
cancel_at
string<date-time> | null
cancelled_at
string<date-time> | null