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.

Migrate existing transactions or fees

Resource Summary

Security

Content Type

application/json

Category

Developer migration,

Migrate existing transactions or fees

POST

Migrate existing transactions or fees

Migrate existing transactions or fees. See also Migrating developers to monetization.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/transactions

Query Parameters

Name Values Description
force

Flag that specifies whether to skip validation steps and forcibly set the number of transactions. By default, ?force=false and validation steps are executed. For example, if a prepaid developer has a zero balance and activity on the account is suspended, if ?force=false the request will fail during validation.

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "application": { "properties": { "id": { "type": "string", "description": "ID of the application. Required only when migrating a batch transaction; not required when charging fees." } } }, "batchSize": { "type": "integer", "description": "When migrating transactions, specifies the number of transactions that you want to transfer. Defaults to 1. Required only when migrating a batch transaction; not required when charging fees." }, "custAttn": { "type": "number", "description": "When migrating transactions, specifies the value of the custom attribute that is used with batchSize to calculate the transaction usage. The custom attribute number in the message must be specified as a positive whole or decimal (up to four decimal places) value. Negative values are not allowed. The custom attribute must be defined in either the transaction recording policy for the API product or the active rate plan for the API product. Required only when migrating a batch transaction; not required when charging fees." }, "currency": { "properties": { "id": { "type": "string", "description": "Currency used for the rate plan. Specify the ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc. Required only when charging a setup or recurring fee; not required when migrating a batch transaction." } } }, "developer": { "properties": { "id": { "type": "string", "description": "ID of the developer. Required only when charging a setup or recurring fee; not required when migrating a batch transaction." } } }, "product": { "properties": { "id": { "type": "string", "description": "ID of the API product. Required only when migrating a batch transaction; not required when charging a setup or recurring fee." } } }, "rate": { "type": "number", "description": "Setup or recurring fee to charge. Required only when charging a setup or recurring fee; not required when migrating a batch transaction." }, "ratePlan": { "properties": { "id": { "type": "string", "description": "ID of the rate plan. Required only when charging a setup or recurring fee; not required when migrating a batch transaction." } } }, "type": { "type": "string", "description": "Type of migration. Valid values include: CHARGE, SETUPFEES, or RECURRINGFEES. Defaults to CHARGE. Required only when charging setup or recurring fees." } }

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?)