Sign in
Subscriptions

Get subscription

Retrieves a subscription for the specified organization.

get/organizations/{organization_id}/subscriptions/{subscription_id}

Path parameters

organization_idstring ulid required

The ID of the organization.

subscription_idstring required

The ID of the subscription.

Response

OK

idstring

The internal ID of the subscription.

status'requested' | 'provisioning failure' | 'provisioning' | 'active' | 'suspended' | 'deleted'

The status of the subscription.

created_atstring date-time

The date and time when the subscription was created.

updated_atstring date-time

The date and time when the subscription was last updated.

ownerstring uuid

The UUID of the owner.

vendorstring

The machine name of the vendor the subscription belongs to.

planstring

The plan type of the subscription.

environmentsinteger

The number of environments which can be provisioned on the project.

storageinteger

The total storage available to each environment, in MiB. Only multiples of 1024 are accepted as legal values.

user_licensesinteger

The number of chargeable users who currently have access to the project. Manage this value by adding and removing users through the Platform project API. Staff and billing/administrative contacts can be added to a project for no charge. Contact support for questions about user licenses.

project_idstring

The unique ID string of the project.

project_endpointstring

The project API endpoint for the project.

project_titlestring

The name given to the project. Appears as the title in the UI.

project_regionstring

The machine name of the region where the project is located. Cannot be changed after project creation.

project_region_labelstring

The human-readable name of the region where the project is located.

project_uistring

The URL for the project's user interface.

agency_siteboolean

True if the project is an agency site.

invoicedboolean

Whether the subscription is invoiced.

hipaaboolean

Whether the project is marked as HIPAA.

is_trial_planboolean

Whether the project is currently on a trial plan.

servicesobject[]

Details of the attached services.

greenboolean

Whether the subscription is considered green (on a green region, belonging to a green vendor) for billing purposes.

Changes

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