Skip to main content
GET
Describe subscription
Returns the full details of a subscription, including the plan it is attached to, your role in it, and its billing state.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>.

Path parameters

string
required
The subscription ID, for example sub-abc123.

Response

string
required
ID of the subscription.
string
required
Subscription status: ACTIVE, SUSPENDED, CANCELLED, or TERMINATED.
string
required
Your role in this subscription, for example root, editor, or reader.
boolean
required
Whether this is the default subscription for the user.
string
required
ID of the subscribed service.
string
required
Name of the service.
string
required
Logo for the service.
string
required
ID of the organization that owns the service.
string
required
Name of the organization that owns the service.
string
required
ID of the subscribed product tier.
string
required
Name of the product tier.
string[]
required
Cloud providers available to this subscription.
string
required
ID of the user that owns the subscription.
string
Name of the user that owns the subscription.
string
ID of the owning user’s organization.
string
Name of the owning user’s organization.
string
required
Name of the subscription owner.
string
required
ID of the organization the account configuration belongs to.
number
Maximum number of deployment instances allowed for this subscription.
boolean
true when a payment method is configured, or when none is required.
boolean
Whether instances can be created before a payment method is configured.
string
required
Time the subscription was created.

Errors

See Error for the error response shape.