You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Make a billing adjustment

Resource Summary

Security

Content Type

application/json

Category

Billing adjustments,

Make a billing adjustment

POST

Make a billing adjustment

Make a billing adjustment for the specified organization. If you do not specify an optional property, the billing adjustment will be all inclusive for that property. For example, if you do not specify a transaction type, the billing adjustment will apply to all transaction types. See also Making a billing adjustment using the API.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/billing-adjustments

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "adjustmentPercentageFactor": { "type": "number", "description": "Percentage factor by which to adjust the bill. This value can be positive or negative to increase or reduce the bill, respectively. Valid values are in the range of -100 to 999.9999." }, "billingMonth": { "type": "string", "description": "Billing month, specified as an integer. For example, 11 for December." }, "billingYear": { "type": "integer", "description": "Billing year, specified using the following format: YYYY. For example, 2017." }, "developerBillingType": { "type": "string", "description": "Developer billing type for which the billing adjustment applies. Valid values include: PREPAID, POSTPAID, BOTH." }, "isPublished": { "type": "boolean", "description": "Flag that specifies whether the billing adjustment should be published." }, "name": { "type": "string", "description": "Name that describes the billing adjustment." }, "monetizationPackage": { "properties": { "id": { "type": "string", "description": "ID of the API package." } } }, "organization": { "properties": { "id": { "type": "string", "description": "ID of the organization." } } }, "product": { "properties": { "id": { "type": "string", "description": "ID of the organization." } } }, "transactionType": { "type": "string", "description": "Type of transaction for which the billing adjustment applies. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, TRUEUPS. TRUEUPS are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month." } }

org_name Name of your organization. true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)