- v202209-2 (latest)
- v202209-1
- v202208-3
- v202208-2
- v202208-1
- v202207-2
- v202207-1
- v202206-1
- Overview
- API Docs template
- Overview
- Account
- Agent Pools
- Agent Tokens
- Applies
- Audit Trails
- Comments
- Configuration Versions
- Cost Estimates
- Feature Sets
- Invoices
- Notification Configurations
- OAuth Clients
- OAuth Tokens
- Organizations
- Organization Memberships
- Organization Tags
- Organization Tokens
- Plan Exports
- Plans
- Policies
- Policy Checks
- Policy Sets
- Policy Set Parameters
- Runs
- Run Triggers
- SSH Keys
- State Versions
- State Version Outputs
- Subscriptions
- Team Access
- Team Membership
- Team Tokens
- Teams
- User Tokens
- Users
- Variables
- VCS Events
- Workspaces
- Workspace-Specific Variables
- Workspace Resources
- Variable Sets
- Changelog
- Stability Policy
- Operational Modes
- Migrating to Terraform Enterprise
- Support
- Terraform Cloud Agents
- Intro to Terraform
- Configuration Language
- Terraform CLI
- Terraform Cloud
- Terraform Enterprise
- Provider Use
- Plugin Development
- Registry Publishing
- Integration Program
- Terraform Tools
- CDK for Terraform
- Glossary
Terraform Enterprise
Other Docs
A new platform for documentation and tutorials is launching soon.
We are migrating Terraform documentation into HashiCorp Developer, our new developer experience.
»Subscriptions API
Note: The subscriptions API is only available in Terraform Cloud.
An organization can subscribe to different feature sets, which represent the pricing plans available in Terraform Cloud. An organization's entitlement set is calculated using its subscription and feature set.
To change the subscription for an organization, use the billing settings in the Terraform Cloud UI.
»Show Subscription For Organization
GET /organizations/:organization_name/subscription
Parameter | Description |
---|---|
:organization_name | The name of the organization. |
»Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request GET \ https://app.terraform.io/api/v2/organizations/hashicorp/subscription
curl \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/vnd.api+json" \
--request GET \
https://app.terraform.io/api/v2/organizations/hashicorp/subscription
»Sample Response
{ "data": { "id": "sub-kyjptCZYXQ6amEVu", "type": "subscriptions", "attributes": { "end-at": null, "is-active": true, "start-at": "2021-01-20T07:03:53.492Z", "runs-ceiling": 1, "contract-start-at": null, "contract-user-limit": null, "contract-apply-limit": null, "agents-ceiling": 0, "is-public-free-tier": true, "is-self-serve-trial": false }, "relationships": { "organization": { "data": { "id": "hashicorp", "type": "organizations" } }, "billing-account": { "data": null }, "feature-set": { "data": { "id": "fs-EvCGYfpx9CVRzteA", "type": "feature-sets" } } }, "links": { "self": "/api/v2/subscriptions/sub-kyjptCZYXQ6amEVu" } }, "included": [ { "id": "fs-EvCGYfpx9CVRzteA", "type": "feature-sets", "attributes": { "comparison-description": "Essential collaboration features for practitioners and small teams.", "cost": 0, "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations", "identifier": "free", "is-current": true, "is-free-tier": true, "name": "Free", "plan": null, "self-serve-billing": true, "cost-estimation": false, "sentinel": false, "run-tasks": false, "teams": false, "user-limit": 5.0, "audit-logging": false, "sso": false, "private-networking": false } } ] }
{
"data": {
"id": "sub-kyjptCZYXQ6amEVu",
"type": "subscriptions",
"attributes": {
"end-at": null,
"is-active": true,
"start-at": "2021-01-20T07:03:53.492Z",
"runs-ceiling": 1,
"contract-start-at": null,
"contract-user-limit": null,
"contract-apply-limit": null,
"agents-ceiling": 0,
"is-public-free-tier": true,
"is-self-serve-trial": false
},
"relationships": {
"organization": {
"data": {
"id": "hashicorp",
"type": "organizations"
}
},
"billing-account": {
"data": null
},
"feature-set": {
"data": {
"id": "fs-EvCGYfpx9CVRzteA",
"type": "feature-sets"
}
}
},
"links": {
"self": "/api/v2/subscriptions/sub-kyjptCZYXQ6amEVu"
}
},
"included": [
{
"id": "fs-EvCGYfpx9CVRzteA",
"type": "feature-sets",
"attributes": {
"comparison-description": "Essential collaboration features for practitioners and small teams.",
"cost": 0,
"description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
"identifier": "free",
"is-current": true,
"is-free-tier": true,
"name": "Free",
"plan": null,
"self-serve-billing": true,
"cost-estimation": false,
"sentinel": false,
"run-tasks": false,
"teams": false,
"user-limit": 5.0,
"audit-logging": false,
"sso": false,
"private-networking": false
}
}
]
}
»Show Subscription By ID
GET /subscriptions/:id
Parameter | Description |
---|---|
:id | The ID of the Subscription to show |
»Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request GET \ https://app.terraform.io/api/v2/organizations/hashicorp/subscription
curl \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/vnd.api+json" \
--request GET \
https://app.terraform.io/api/v2/organizations/hashicorp/subscription
»Sample Response
{ "data": { "id": "sub-kyjptCZYXQ6amEVu", "type": "subscriptions", "attributes": { "end-at": null, "is-active": true, "start-at": "2021-01-20T07:03:53.492Z", "runs-ceiling": 1, "contract-start-at": null, "contract-user-limit": null, "contract-apply-limit": null, "agents-ceiling": 0, "is-public-free-tier": true, "is-self-serve-trial": false }, "relationships": { "organization": { "data": { "id": "hashicorp", "type": "organizations" } }, "billing-account": { "data": null }, "feature-set": { "data": { "id": "fs-EvCGYfpx9CVRzteA", "type": "feature-sets" } } }, "links": { "self": "/api/v2/subscriptions/sub-kyjptCZYXQ6amEVu" } }, "included": [ { "id": "fs-EvCGYfpx9CVRzteA", "type": "feature-sets", "attributes": { "comparison-description": "Essential collaboration features for practitioners and small teams.", "cost": 0, "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations", "identifier": "free", "is-current": true, "is-free-tier": true, "name": "Free", "plan": null, "self-serve-billing": true, "cost-estimation": false, "sentinel": false, "run-tasks": false, "teams": false, "user-limit": 5.0, "audit-logging": false, "sso": false, "private-networking": false } } ] }
{
"data": {
"id": "sub-kyjptCZYXQ6amEVu",
"type": "subscriptions",
"attributes": {
"end-at": null,
"is-active": true,
"start-at": "2021-01-20T07:03:53.492Z",
"runs-ceiling": 1,
"contract-start-at": null,
"contract-user-limit": null,
"contract-apply-limit": null,
"agents-ceiling": 0,
"is-public-free-tier": true,
"is-self-serve-trial": false
},
"relationships": {
"organization": {
"data": {
"id": "hashicorp",
"type": "organizations"
}
},
"billing-account": {
"data": null
},
"feature-set": {
"data": {
"id": "fs-EvCGYfpx9CVRzteA",
"type": "feature-sets"
}
}
},
"links": {
"self": "/api/v2/subscriptions/sub-kyjptCZYXQ6amEVu"
}
},
"included": [
{
"id": "fs-EvCGYfpx9CVRzteA",
"type": "feature-sets",
"attributes": {
"comparison-description": "Essential collaboration features for practitioners and small teams.",
"cost": 0,
"description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
"identifier": "free",
"is-current": true,
"is-free-tier": true,
"name": "Free",
"plan": null,
"self-serve-billing": true,
"cost-estimation": false,
"sentinel": false,
"run-tasks": false,
"teams": false,
"user-limit": 5.0,
"audit-logging": false,
"sso": false,
"private-networking": false
}
}
]
}