User APIs
subscriptions

Get User Plan

Get all active subscription plans for the current user's client.

Returns all subscriptions with active status (active/trialing/past_due). If no active subscriptions exist, returns an empty list.

All data is sourced from:

  • StripeSubscription model columns
  • meta_data field (custom Stripe metadata)
  • raw field (full Stripe subscription object)
  • daily_token_limit column

Returns: List[ClientPlanDetails]: List of all active subscription plans for the client

get/api/v1/subscriptions/plan

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/subscriptions/plan
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Response

Successful Response

idstring required
slugstring required
client_idstring uuid required
descriptionstring nullable
notesstring nullable
platform_feenumber nullable
client_admin_emailstring nullable
client_admin_namestring nullable
platform_fee_schedulestring nullable
payment_methodstring nullable
plan_start_datestring date-time nullable
free_tokens_amountnumber nullable
free_tokens_duration_countinteger nullable
free_tokens_durationstring nullable
daily_token_limitnumber nullable
is_mcp_planboolean
plan_typestring
setup_payment_on_behalf_of_the_clientboolean
billing_cycle_limitinteger nullable
auto_renewboolean
disable_invoice_as_payment_methodboolean
invoice_paymentboolean
is_activeboolean
plan_namestring nullable
product_namestring nullable
subscription_idstring required
statusstring required
current_period_startstring date-time nullable
current_period_endstring date-time nullable
cancel_atstring date-time nullable
canceled_atstring date-time nullable
trial_endstring date-time nullable
created_atstring date-time nullable
updated_atstring date-time nullable
extra_dataobject nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.