Monetization API
Monetize your APIs. For more information, see Monetization overview.
Resource Types
APIPackage
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/monetization-packages | Lists API packages accepted by a company. See also Viewing API product bundle accepted by a developeror company using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/monetization-packages | Lists all API packages accepted by a developer. See also Viewing API product bundle accepted by a developeror company using the API. |
get | /mint/organizations/{org_name}/monetization-packages | Lists API packages for the specified organization. See also Viewing API product bundles using the API. |
post | /mint/organizations/{org_name}/monetization-packages | Creates an API package. An API package is a collection of API products that is presented to developers as a bundle, and typically associated with one or more rate plans for monetization. An API package does not become visible to developers until you publish a rate plan for the package (with a start date of the current or future date). Developers can register their apps to use an API package only by purchasing one of the rate plans currently in effect. If an API package does not have a published rate plan that is currently in effect, the package is not monetized. You can create multiple API packages. You decide which API products to include in each API package. You can even put the same API product or products in different packages and associate them with the same or different rate plans. After you add an API product to a package, you may need to set up price points for the API product. You need to do this only if all of the following are true:
The minimum and maximum prices are displayed in the details for the API package. See also Creating an API product bundle using the API. Note: Once you create a package, you cannot delete it. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id} | Gets an API package for the specified organization. See also Viewing API product bundle using the API. |
get | /mint/organizations/{org_name}/packages-with-transactions | Lists API packages with transactions for the specified organization. See also Reporting transaction activity using the API. |
APIPackages
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/monetization-packages | Lists API packages accepted by a company. See also Viewing API product bundle accepted by a developeror company using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/monetization-packages | Lists all API packages accepted by a developer. See also Viewing API product bundle accepted by a developeror company using the API. |
get | /mint/organizations/{org_name}/monetization-packages | Lists API packages for the specified organization. See also Viewing API product bundles using the API. |
get | /mint/organizations/{org_name}/packages-with-transactions | Lists API packages with transactions for the specified organization. See also Reporting transaction activity using the API. |
APIProduct
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/applications-with-transactions | Gets transaction activity for applications. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/billing-adjustments | Lists billing adjustments for the organization. See also Viewing billing adjustments using the API. |
post | /mint/organizations/{org_name}/billing-adjustments | Makes 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. |
get | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Gets the specified billing adjustment for the organization. See also Viewing billing adjustments using the API. |
put | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Updates the specified billing adjustment for the organization. You must specify all of the same properties that you set when creating the billing adjustment and include the ID of the billing adjustment. You can modify the name and adjustment percentage values only. See also Updating a billing adjustment using the API. Note: When you update a billing adjustment, you need to specify all the billing adjustement settings, not only the settings you want to update. You might want to get the billing adjustment, copy the response payload, modify it as required, and then pass the modified payload in the request body. |
get | /mint/organizations/{org_name}/companies/{company_id}/eligible-products | Gets the API products that a company is eligible to access, including:
See also View API products. |
get | /mint/organizations/{org_name}/developers/{developer_email}/eligible-products | Gets the API products that a developer is eligible to access, including:
See also View API products. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions | Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also Issuing the credits using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions | Post a refund to an API package. See also Posting a refund using the API. |
get | /mint/organizations/{org_name}/products | Lists API products for the specified organization. See also Manage API products. |
get | /mint/organizations/{org_name}/products-with-transactions | Gets transaction activity for API products. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/products/{product_id} | Gets an API product in the specified organization. See also Manage API products. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
APIProducts
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/products | Lists API products for the specified organization. See also Manage API products. |
get | /mint/organizations/{org_name}/products-with-transactions | Gets transaction activity for API products. See also Reporting transaction activity using the API. |
AcceptRateplan
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
AcceptTNC
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/developers/{developer_email}/tncs/{tncs_id}/developer-tncs | Accept the terms and conditions document for a developer. See also Manage terms and conditions using the API. |
Address
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name} | Gets the organization profile. See also View the organization profile using the API. |
put | /mint/organizations/{org_name} | Update the organization profile. See also Edit the organization profile using the API. Note: When you update the organization profile, you need to specify all the organization profile settings, not only the settings you want to update. You might want to get the organization profile copy the response payload, modify it as required, and then pass the modified payload in the request body. |
get | /mint/organizations/{org_name}/developers | Gets the monetization information for all developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers-with-transactions | Gets transaction activity for developers. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email} | Gets the monetization information for a developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
Application
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/applications-with-transactions | Gets transaction activity for applications. See also Reporting transaction activity using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions | Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also Issuing the credits using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions | Post a refund to an API package. See also Posting a refund using the API. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
BillingAdjustment
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/billing-adjustments | Lists billing adjustments for the organization. See also Viewing billing adjustments using the API. |
post | /mint/organizations/{org_name}/billing-adjustments | Makes 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. |
get | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Gets the specified billing adjustment for the organization. See also Viewing billing adjustments using the API. |
put | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Updates the specified billing adjustment for the organization. You must specify all of the same properties that you set when creating the billing adjustment and include the ID of the billing adjustment. You can modify the name and adjustment percentage values only. See also Updating a billing adjustment using the API. Note: When you update a billing adjustment, you need to specify all the billing adjustement settings, not only the settings you want to update. You might want to get the billing adjustment, copy the response payload, modify it as required, and then pass the modified payload in the request body. |
BillingAdjustments
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/billing-adjustments | Lists billing adjustments for the organization. See also Viewing billing adjustments using the API. |
Condition
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
post | /mint/organizations/{org_name}/notification-conditions | Creates a notification condition and action. See also Configuring notification conditions and actions using the API. |
put | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Updates a notification condition and action. See also Configuring notification conditions and actions using the API. |
CreditLimit
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit | Gets the credit limit for a developer. See also Retrieving a credit limit using the API. |
Developer
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers | Gets the monetization information for all developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers-with-transactions | Gets transaction activity for developers. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email} | Gets the monetization information for a developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
DeveloperCategories
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developer-categories | Lists developer categories in an organization. See also Retrieving developer categories using the API. |
DeveloperCategory
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developer-categories | Lists developer categories in an organization. See also Retrieving developer categories using the API. |
post | /mint/organizations/{org_name}/developer-categories | Creates a developer category for an organization. See also Creating a developer category using the API. |
get | /mint/organizations/{org_name}/developer-categories/{category_id} | Gets details of a developer category. See also Retrieving developer categories using the API. |
put | /mint/organizations/{org_name}/developer-categories/{category_id} | Updates a developer category for an organization. See also Updating a developer category using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
DeveloperInfo
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Create a report definition for a developer. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions | Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also Issuing the credits using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions | Post a refund to an API package. See also Posting a refund using the API. |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
get | /mint/organizations/{org_name}/report-definitions | Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/report-definitions | Create a report definition for an organization. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
get | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Gets details for a report definition. See also Viewing report definitions using the API. |
put | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Updates a report definition. See also Updating a report definition using the API. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
DeveloperRatePlan
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
DeveloperRatePlans
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
DeveloperRole
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developer-roles | Lists developer roles in an organization. See Retrieving a developer role. |
post | /mint/organizations/{org_name}/developer-roles | Creates a developer role for an organization. See Creating a developer role. |
DeveloperRoles
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developer-roles | Lists developer roles in an organization. See Retrieving a developer role. |
DeveloperTNC
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-tncs | Gets the terms and conditions documents accepted by the specified developer. See also Viewing terms and conditions accepted by a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/tncs/{tncs_id}/developer-tncs | Accept the terms and conditions document for a developer. See also Manage terms and conditions using the API. |
DeveloperTNCs
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-tncs | Gets the terms and conditions documents accepted by the specified developer. See also Viewing terms and conditions accepted by a developer using the API. |
Developers
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers | Gets the monetization information for all developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers-with-transactions | Gets transaction activity for developers. See also Reporting transaction activity using the API. |
EligibleProducts
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/eligible-products | Gets the API products that a company is eligible to access, including:
See also View API products. |
get | /mint/organizations/{org_name}/developers/{developer_email}/eligible-products | Gets the API products that a developer is eligible to access, including:
See also View API products. |
MintCriteria
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Create a report definition for a developer. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/revenue-reports | Generates a revenue report for a developer. See also Generating a report using the API. |
get | /mint/organizations/{org_name}/report-definitions | Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/report-definitions | Create a report definition for an organization. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
get | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Gets details for a report definition. See also Viewing report definitions using the API. |
put | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Updates a report definition. See also Updating a report definition using the API. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
post | /mint/organizations/{org_name}/{report_type} | Generate a report of the specified type. See also Generating a report using the API. |
NotificationAction
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
post | /mint/organizations/{org_name}/notification-conditions | Creates a notification condition and action. See also Configuring notification conditions and actions using the API. |
put | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Updates a notification condition and action. See also Configuring notification conditions and actions using the API. |
NotificationCondition
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/notification-conditions | Creates a notification condition and action. See also Configuring notification conditions and actions using the API. |
get | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Gets a notification condition and action. See also Configuring notification conditions and actions using the API. |
put | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Updates a notification condition and action. See also Configuring notification conditions and actions using the API. |
NotificationConditionAction
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
NotificationConditionDetails
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
NotificationConditionsActions
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
NotificationEmailTemplate
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-email-templates | Lists notification email templates. The items in the templates that begin with |
post | /mint/organizations/{org_name}/notification-email-templates | Creates a notification email template. See also Managing notification templates using the API. |
get | /mint/organizations/{org_name}/notification-email-templates/{template_id} | Gets a notification email template. See also Managing notification templates using the API. |
put | /mint/organizations/{org_name}/notification-email-templates/{template_id} | Updates a notification email template. See also Managing notification templates using the API. |
NotificationEmailTemplates
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/notification-email-templates | Lists notification email templates. The items in the templates that begin with |
NotificationRequest
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/notification-conditions | Creates a notification condition and action. See also Configuring notification conditions and actions using the API. |
put | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Updates a notification condition and action. See also Configuring notification conditions and actions using the API. |
Organization
Method | Endpoint | Description |
---|---|---|
put | /mint/organizations/{org_name} | Update the organization profile. See also Edit the organization profile using the API. Note: When you update the organization profile, you need to specify all the organization profile settings, not only the settings you want to update. You might want to get the organization profile copy the response payload, modify it as required, and then pass the modified payload in the request body. |
get | /mint/organizations/{org_name}/applications-with-transactions | Gets transaction activity for applications. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/billing-adjustments | Lists billing adjustments for the organization. See also Viewing billing adjustments using the API. |
post | /mint/organizations/{org_name}/billing-adjustments | Makes 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. |
get | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Gets the specified billing adjustment for the organization. See also Viewing billing adjustments using the API. |
put | /mint/organizations/{org_name}/billing-adjustments/{billing_adjustment_id} | Updates the specified billing adjustment for the organization. You must specify all of the same properties that you set when creating the billing adjustment and include the ID of the billing adjustment. You can modify the name and adjustment percentage values only. See also Updating a billing adjustment using the API. Note: When you update a billing adjustment, you need to specify all the billing adjustement settings, not only the settings you want to update. You might want to get the billing adjustment, copy the response payload, modify it as required, and then pass the modified payload in the request body. |
get | /mint/organizations/{org_name}/companies/{company_id}/eligible-products | Gets the API products that a company is eligible to access, including:
See also View API products. |
get | /mint/organizations/{org_name}/developer-roles | Lists developer roles in an organization. See Retrieving a developer role. |
post | /mint/organizations/{org_name}/developer-roles | Creates a developer role for an organization. See Creating a developer role. |
get | /mint/organizations/{org_name}/developers | Gets the monetization information for all developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers-with-transactions | Gets transaction activity for developers. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email} | Gets the monetization information for a developers in an organization. You can define the monetization information by passing custom attributes when creating or updating a developer. You can get the monetization custom attributes set using the standard (non-monetization) API to get all developers or a single developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-tncs | Gets the terms and conditions documents accepted by the specified developer. See also Viewing terms and conditions accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/eligible-products | Gets the API products that a developer is eligible to access, including:
See also View API products. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Create a report definition for a developer. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/tncs/{tncs_id}/developer-tncs | Accept the terms and conditions document for a developer. See also Manage terms and conditions using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions | Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also Issuing the credits using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions | Post a refund to an API package. See also Posting a refund using the API. |
get | /mint/organizations/{org_name}/notification-conditions | Lists notification conditions and actions. See also Configuring notification conditions and actions using the API. |
post | /mint/organizations/{org_name}/notification-conditions | Creates a notification condition and action. See also Configuring notification conditions and actions using the API. |
put | /mint/organizations/{org_name}/notification-conditions/{condition_id} | Updates a notification condition and action. See also Configuring notification conditions and actions using the API. |
get | /mint/organizations/{org_name}/products | Lists API products for the specified organization. See also Manage API products. |
get | /mint/organizations/{org_name}/products-with-transactions | Gets transaction activity for API products. See also Reporting transaction activity using the API. |
get | /mint/organizations/{org_name}/products/{product_id} | Gets an API product in the specified organization. See also Manage API products. |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
get | /mint/organizations/{org_name}/report-definitions | Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/report-definitions | Create a report definition for an organization. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
get | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Gets details for a report definition. See also Viewing report definitions using the API. |
put | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Updates a report definition. See also Updating a report definition using the API. |
get | /mint/organizations/{org_name}/tncs | Lists terms and conditions. See also Viewing terms and conditions using the API. |
post | /mint/organizations/{org_name}/tncs | Add terms and conditions. See also Adding terms and conditions using the API. |
get | /mint/organizations/{org_name}/tncs/{tncs_id} | Gets a terms and conditions document. See also Viewing terms and conditions using the API. |
put | /mint/organizations/{org_name}/tncs/{tncs_id} | Updates a terms and conditions document. See also Updating terms and conditions using the API. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
OrganizationProfile
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name} | Gets the organization profile. See also View the organization profile using the API. |
put | /mint/organizations/{org_name} | Update the organization profile. See also Edit the organization profile using the API. Note: When you update the organization profile, you need to specify all the organization profile settings, not only the settings you want to update. You might want to get the organization profile copy the response payload, modify it as required, and then pass the modified payload in the request body. |
PaymentProvider
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/providers | Gets third-party payment providers for your organization. See also Viewing the payment providers configured for your organization. |
post | /mint/organizations/{org_name}/providers | Configure third-party payment providers for your organization. See also Viewing the payment providers configured for your organization. |
put | /mint/organizations/{org_name}/providers/{provider_id} | Updates third-party payment providers for your organization. See also Viewing the payment providers configured for your organization. |
PaymentProviders
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/providers | Gets third-party payment providers for your organization. See also Viewing the payment providers configured for your organization. |
PrepaidBalance
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Gets prepaid account balance and recurring setup for a company. See also Viewing prepaid account balances for a company. |
post | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Reload prepaid account balance for a company. See also Reloading a prepaid account balance using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Gets account balance for a developer. See also Viewing prepaid account balances for a developer. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Reload prepaid account balance for a developer. See also Reloading a prepaid account balance using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit | Sets a credit limit for a developer. See also Setting a credit limit using the API. Note: When you add a supported currency for an organization, you can set a credit limit. The credit limit applies to all postpaid developers in the organization. This API overrides the credit limit for the specified developer only.' |
PrepaidBalanceDeveloper
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances/recurring-setup | Set up automatic reload of prepaid account balance for a developer. See also Setting up automatic reload of prepaid account balances for a developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit | Gets the credit limit for a developer. See also Retrieving a credit limit using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/prepaid-developer-balance | Gets prepaid account balance information including current and total balance, usage, top ups, and usage tax. See also Viewing prepaid account balances for a developer. |
PrepaidBalanceDevelopers
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances/recurring-setup | Set up automatic reload of prepaid account balance for a developer. See also Setting up automatic reload of prepaid account balances for a developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/prepaid-developer-balance | Gets prepaid account balance information including current and total balance, usage, top ups, and usage tax. See also Viewing prepaid account balances for a developer. |
PrepaidBalanceReload
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup | Set up automatic reload of prepaid account balance for a company. See also Setting up automatic reload of prepaid account balances for a company. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances/recurring-setup | Set up automatic reload of prepaid account balance for a developer. See also Setting up automatic reload of prepaid account balances for a developer. |
PrepaidBalances
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Gets prepaid account balance and recurring setup for a company. See also Viewing prepaid account balances for a company. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Gets account balance for a developer. See also Viewing prepaid account balances for a developer. |
Rateplan
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
RateplanDetails
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
RateplanRates
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-accepted-rateplans | Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Accept a published rate plan for a developer. See also Accept published rate plans using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans/{developer_rateplan_id} | Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} | Adds an API product to an API package. If you have an API product-specific rate plan defined (rate card or revenue share), you can specify the details in the request body. Otherwise, specify See also Managing the API products in an API product bundle using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | A rate plan specifies the monetization approach for your API package or for individual API products in the package. For example, it specifies whether you charge for the use of your API package and products based on a flat rate or a variable rate, and whether there are additional fees. You define the type of plan to indicate whether it applies to all developers, developers in a specific category, or a specific developer. You can configure the following features:
After you initially set up a rate plan, you can update it to add fees, add a fremium plan, or specify additional rate plan details. Note: You can set up multiple rate plans for an API package. See also Create rate plans. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API. |
put | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} | Update a rate plan for an API package. See also Editing a rate plan draft using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/revision | Create a revision of an existing rate plan. A revision is a new plan; the original plan and the revision both exist as rate plans. After an existing rate plan is published, the only property you can change is its end date. However, you can create a new version of the plan that includes changed properties, such as changed rate plan rates. You can set up the revision to go into effect at a future date. The original rate plan ends when the revision goes into effect. Developers are notified about the revision. Those developers who accept the original rate plan are automatically registered for the revision (but have the option of rejecting the revision). ' |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
Rateplans
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-rateplans | Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/products/{product_id}/rate-plan-by-developer-product | Lists active rate plans for a developer that contain an API product. See also Viewing all active rate plans for a developer that contain an API product using the API. |
get | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans | Lists rate plans for an API package. See also Viewing rate plans using the API. |
get | /mint/organizations/{org_name}/rate-plans | Lists rate plans for your organization. See also Viewing rate plans using the API. |
Reload
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Reload prepaid account balance for a company. See also Reloading a prepaid account balance using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Reload prepaid account balance for a developer. See also Reloading a prepaid account balance using the API. |
ReportDefinition
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Create a report definition for a developer. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
get | /mint/organizations/{org_name}/report-definitions | Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
post | /mint/organizations/{org_name}/report-definitions | Create a report definition for an organization. You must create a report definition before you can generate a report. See also Creating a report definition using the API. |
get | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Gets details for a report definition. See also Viewing report definitions using the API. |
put | /mint/organizations/{org_name}/report-definitions/{report_definition_id} | Updates a report definition. See also Updating a report definition using the API. |
ReportDefinitions
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/report-definitions | Gets report definitions for a developer. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
get | /mint/organizations/{org_name}/report-definitions | Gets report definitions for an organization. You can specify query parameters to limit the number of report definitions returned or to sort them using a specified field. See also Viewing report definitions using the API. |
ScheduledJob
Method | Endpoint | Description |
---|---|---|
get | /triggers | Lists currently scheduled monetization jobs. See also Viewing scheduled jobs using the API. Notes:
|
get | /triggers/{trig_id} | Gets a scheduled monetization job. See also Viewing scheduled jobs using the API. Notes:
|
put | /triggers/{trig_id} | Updates scheduled monetization jobs. See also Updating scheduled jobs using the API. Notes:
|
ScheduledJobs
Method | Endpoint | Description |
---|---|---|
get | /triggers | Lists currently scheduled monetization jobs. See also Viewing scheduled jobs using the API. Notes:
|
SupportedCurrencies
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/supported-currencies | Gets supported currencies. See also Retrieving supported currencies using the API. |
SupportedCurrency
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Gets prepaid account balance and recurring setup for a company. See also Viewing prepaid account balances for a company. |
post | /mint/organizations/{org_name}/companies/{company_id}/developer-balances | Reload prepaid account balance for a company. See also Reloading a prepaid account balance using the API. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Gets account balance for a developer. See also Viewing prepaid account balances for a developer. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances | Reload prepaid account balance for a developer. See also Reloading a prepaid account balance using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-balances/recurring-setup | Set up automatic reload of prepaid account balance for a developer. See also Setting up automatic reload of prepaid account balances for a developer. |
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit | Gets the credit limit for a developer. See also Retrieving a credit limit using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/developer-credit-limit | Sets a credit limit for a developer. See also Setting a credit limit using the API. Note: When you add a supported currency for an organization, you can set a credit limit. The credit limit applies to all postpaid developers in the organization. This API overrides the credit limit for the specified developer only.' |
get | /mint/organizations/{org_name}/developers/{developer_email}/prepaid-developer-balance | Gets prepaid account balance information including current and total balance, usage, top ups, and usage tax. See also Viewing prepaid account balances for a developer. |
get | /mint/organizations/{org_name}/supported-currencies | Gets supported currencies. See also Retrieving supported currencies using the API. |
post | /mint/organizations/{org_name}/supported-currencies | Adds a supported currency. See also Adding supported currencies using the API. |
get | /mint/organizations/{org_name}/supported-currencies/{supportedcurrency_id} | Gets details for a supported currency. See also Retrieving supported currencies using the API. |
put | /mint/organizations/{org_name}/supported-currencies/{supportedcurrency_id} | Updates a supported currency. See also Updating a supported currency using the API. Note: All properties in the request body are required. |
SuspendedDeveloper
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/suspended-developers | Lists suspended developers for an organization. See also Viewing all suspended developers using the API. |
post | /mint/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id} | Unsuspend all developers for an API product. See also Unsuspending all developers for an API product using the API. |
get | /mint/organizations/{org_name}/suspended-developers/{id} | Gets a suspended developer for an organization. See also Viewing a suspended developer using the API. |
SuspendedDevelopers
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/suspended-developers | Lists suspended developers for an organization. See also Viewing all suspended developers using the API. |
TNC
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/developers/{developer_email}/developer-tncs | Gets the terms and conditions documents accepted by the specified developer. See also Viewing terms and conditions accepted by a developer using the API. |
post | /mint/organizations/{org_name}/developers/{developer_email}/tncs/{tncs_id}/developer-tncs | Accept the terms and conditions document for a developer. See also Manage terms and conditions using the API. |
get | /mint/organizations/{org_name}/tncs | Lists terms and conditions. See also Viewing terms and conditions using the API. |
post | /mint/organizations/{org_name}/tncs | Add terms and conditions. See also Adding terms and conditions using the API. |
get | /mint/organizations/{org_name}/tncs/{tncs_id} | Gets a terms and conditions document. See also Viewing terms and conditions using the API. |
put | /mint/organizations/{org_name}/tncs/{tncs_id} | Updates a terms and conditions document. See also Updating terms and conditions using the API. |
TNCs
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/tncs | Lists terms and conditions. See also Viewing terms and conditions using the API. |
Transaction
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}/real-currency-credit-transactions | Issues credit to a developer. You can apply credit against a package as a whole, or against the use of a specific product within a package. See also Issuing the credits using the API. |
post | /mint/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions | Post a refund to an API package. See also Posting a refund using the API. |
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
Transactions
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/transaction-search | Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API. |
TransactionsMigrate
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/transactions | Migrates existing transactions or fees. See also Migrating developers to monetization. |
Webhook
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/webhooks | Lists webhooks. See also Viewing all webhooks using the API. |
post | /mint/organizations/{org_name}/webhooks | Creates a webhook. See also Creating a webhook using the API. |
get | /mint/organizations/{org_name}/webhooks/{webhook_id} | Gets a webhook. See also Viewing a webhook using the API. |
post | /mint/organizations/{org_name}/webhooks/{webhook_id} | Updates a webhook. See also Updating a webhook using the API. |
WebhookSample
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email}/{app_id}/{product_id}/{rateplan_id}/{trigger_type} | Gets a sample request payload for the webhook trigger type. See also Viewing a sample request payload for webhook notification testing. |
WebhookTest
Method | Endpoint | Description |
---|---|---|
post | /mint/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email}/{app_id}/{product_id}/{rateplan_id} | Test the execution of a webhook. See also Testing the execution of a webhook. |
Webhooks
Method | Endpoint | Description |
---|---|---|
get | /mint/organizations/{org_name}/webhooks | Lists webhooks. See also Viewing all webhooks using the API. |