Companies API

Manage companies in an organization.

A company is a collection of developers managed as a single entity. A company can be any grouping that is appropriate to your organization, for example, business unit, product line, or division. Grouping developers into companies is useful when your goal is to work with multiple developers associated under a single corporate entity for billing purposes, for example.

Companies are optional. It not required that the developers in your organization are associated with a company. Note that a developer is always a single entity, uniquely identified by the email element.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

Companies

For more information, see Companies.
No methods use this type.

Company

For more information, see Company.
MethodEndpointDescription
post/organizations/{org_name}/companies

Creates a company in an organization.

You must set the ADMIN_EMAIL attribute to the email of the company administrator.

The company is always created with a status of active. To set the status explicitly, see Update a company.

To set the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.

For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

delete/organizations/{org_name}/companies/{company_name}

Deletes a company.

get/organizations/{org_name}/companies/{company_name}

Gets company details.

put/organizations/{org_name}/companies/{company_name}

Updates an existing company.

Send the complete company record as a payload with any changes you want to make. For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

To update the status of a company, set the action query parameter to active or inactive and Content-type to application/octet-stream. If you set the status to inactive, you cannot access the developers and apps associated with the company. In this case, the API returns a 204: No Content status.

Notes:

  • You cannot update the status of a company by passing the value in the request body.
  • Currently, updating the status of a company cannot be executed using the Try this API panel.

If you want to change the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.

CompanyRequest

For more information, see CompanyRequest.
MethodEndpointDescription
post/organizations/{org_name}/companies

Creates a company in an organization.

You must set the ADMIN_EMAIL attribute to the email of the company administrator.

The company is always created with a status of active. To set the status explicitly, see Update a company.

To set the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.

For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

put/organizations/{org_name}/companies/{company_name}

Updates an existing company.

Send the complete company record as a payload with any changes you want to make. For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

To update the status of a company, set the action query parameter to active or inactive and Content-type to application/octet-stream. If you set the status to inactive, you cannot access the developers and apps associated with the company. In this case, the API returns a 204: No Content status.

Notes:

  • You cannot update the status of a company by passing the value in the request body.
  • Currently, updating the status of a company cannot be executed using the Try this API panel.

If you want to change the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.