Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Delete monetization data for an organization

Introduction

You may wish to delete monetization data for your organization in the following scenarios:

  • Delete your organization. In this case, you must delete the monetization data before you can delete the organization.
  • Clear monetization data from a test organization that you would like to reuse. In this case, you must synchronize the Apigee Edge data after you delete the monetization data.

The following sections describe how to delete data from your Monetization organization:

Enabling the deletion of monetization data from your organization

Before you can delete monetization data from your organization, enable this reporting feature by adding a features.isMintOrgDataDeletionAllowed property to your organization. The method you use to enable this property depends on whether your are an Edge Cloud or Edge for Private Cloud customer.

Apigee Edge Cloud

For Apigee Edge Cloud customers, Apigee will assist you in setting this propery for your organization. Contact your Apigee Support representative for assistance.

Apigee Edge Private Cloud

Set the flag by issuing a PUT call to the following API with System Administrator credentials.

curl -u email:password -X PUT -H "Content-type:application/xml" https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="features.isMintOrgDataDeletionAllowed">true</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

When you update the organization with the API call, be sure to include all the existing organization properties in the payload. If you don't, all existing organization properties are overwritten by only the properties you set with this call.

Deleting data from a Monetization organization

Deleting monetization data from an organization permanently removes the following data:

  • API packages
  • Rate plans
  • Developer accepted rate plans
  • Transactions

The method you use to delete data from a Monetization organization depends on whether your are an Edge Cloud or Edge for Private Cloud customer.

Apigee Edge Cloud

For Apigee Edge Cloud customers, Apigee will assist you in deleting data from a Monetization organization. Contact your Apigee Support representative for assistance.

Apigee Edge Private Cloud

Ensure that your Edge account has system administrator privileges before proceeding.

To delete data from a Monetization organization, issue a POST request to /organizations/{org_name}/delete-org-data, where {org_name} is the name of your organization.

For example, the following request deletes Monetization data from the specified organization:

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/delete-org-data" \
-u email:password

The following provides an example of the response:

{
  "id": "c6eaa22d-27bd-46cc-be6f-4f77270818cf",
  "log": "",
  "orgId": "{org_name}",
  "status": "RUNNING",
  "type": "DELETE_ORG"
}

Next steps

Next, perform one of the following steps:

 

Help or comments?