authenticated
billing

Get Subscription

get/billing/subscription

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

organization_idstring nullable

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

status'active' | 'trialing' | 'past_due' | 'canceled' | 'incomplete'

Stripe subscription status mirror.

current_period_endstring nullable
max_seatsinteger nullable
used_seatsinteger
can_add_membersboolean required
seats_remaininginteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.