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.

Add an API product to an API package

Resource Summary

Security

Content Type

application/json

Category

API packages,

Add an API product to an API package

POST

Add an API product to an API package

Add 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 package using the API.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "ratePlan": { "type": "array", "items": { "properties": { "advance": { "type": "boolean", "description": "Flag that specifies whether or not the recurring fee is charged in advance. For example, if set to true and the period is 1 month, the recurring fee is charged on the invoice generated when the prior billing month ends. Defaults to false." }, "contractDuration": { "type": "integer", "description": "Length of the contract for the plan together with contractDurationType. For example, to specify a contract duration of 6 months, set contractDuration to 6 and contractDurationType to MONTH." }, "contractDurationType": { "type": "string", "description": "Length of the contract for the plan together with contractDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "currency": { "properties": { "id": { "type": "string", "description": "ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc." } } }, "description": { "type": "string", "description": "Description of the rate plan." }, "developer": { "properties": { "id": { "type": "string", "description": "ID of the developer." }, "legalName": { "type": "string", "description": "Legal name of the developer." }, "name": { "type": "string", "description": "Name of the developer." } } }, "developerCategory": { "properties": { "id": { "type": "string", "description": "ID of the developer category." }, "name": { "type": "string", "description": "Name of the developer category." }, "description": { "type": "string", "description": "Description of the developer category." } } }, "displayName": { "type": "string", "description": "User-friendly display name for the rate plan." }, "earlyTerminationFee": { "type": "integer", "description": "One-time fee that is charged if the developer ends the plan before the renewal term." }, "endDate": { "type": "string", "description": "Date and time that the plan ends in UTC. Use the following format: YYYY-MM-DD HH:mm:ss. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default. Developers are not able to view the rate plan after this date. If you do not want the rate plan to end on a specific date, specify a null value." }, "freemiumDuration": { "type": "integer", "description": "Period of time for the freemium period together with freemiumDurationType. For example, to specify that the freemium period is 30 days, set freemiumDuration to 30 and freemiumDurationType to DAY." }, "freemiumDurationType": { "type": "string", "description": "Period of time for the freemium period together with freemiumDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumUnit": { "type": "string", "description": "Freemium quantity. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy." }, "frequencyDuration": { "type": "integer", "description": "Together with frequencyDurationType, indicates the period to fime between recurring fee charges. For example, to specify that the period of time between fee charges is 30 days, set frequencyDuration to 30 and frequencyDurationTime to DAY." }, "fequencyDurationType": { "type": "string", "description": "Period of time between recurring fee charges. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "id": { "type": "string", "description": "ID of the rate plan." }, "isPrivate": { "type": "boolean", "description": "Flag that specifies whether the rate plan is public or private. Defaults to false (public)." }, "keepOriginalStartDate": { "type": "boolean", "description": "Flag that specifies whether to maintain the start date of the parent rate plan. Defaults to false. Note: This setting applies to future rate plans only." }, "monetizationPackage": { "properties": { "id": { "type": "string", "description": "Name of the API package for the rate plan." } } }, "name": { "type": "string", "description": "Name of the rate plan." }, "organization": { "properties": { "approvedTrusted": { "type": "boolean", "description": "Flag that specifies whether the developer is given approved status by the organization." }, "approvedUntrusted": { "type": "boolean", "description": "Flag that specifies whether untrusted developers are given approved status by the organization." }, "billingCycle": { "type": "string", "description": "Billing cycle period. Valid values include:
  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
" }, "country": { "type": "string", "description": "ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil." }, "currency": { "type": "string", "description": "ISO 4217 code for the \"base\" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization." }, "description": { "type": "string", "description": "Brief description of the organization." }, "hasBillingAdjustment": { "type": "boolean", "description": "Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products." }, "hasBroker": { "type": "boolean", "description": "Flag that specifies whether the revenue is based on net." }, "hasSelfBilling": { "type": "boolean", "description": "Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer." }, "hasSeparateInvoiceForProduct": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is generated for each API product." }, "id": { "type": "string", "description": "ID of the organization." }, "issueNettingStmt": { "type": "boolean", "description": "Flag that specifies whether a netting statement is generated when creating billing documents." }, "logoUrl": { "type": "string", "description": "URL of the organization's logo." }, "name": { "type": "string", "description": "Name of the organization." }, "netPaymentAdviceNote": { "type": "string", "description": "Net payment advice note." }, "nettingStmtPerCurrency": { "type": "boolean", "description": "Flag that specifies whether a separate netting statement is generated for each currency used." }, "regNo": { "type": "string", "description": "Organization's registration number. The registratino number is displayed at the bottom of billing documents." }, "selfBillingAsExchOrg": { "type": "boolean", "description": "This feature is deprecated." }, "selfBillingForAllDev": { "type": "boolean", "description": "If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider." }, "separateInvoiceForFees": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is published for fees." }, "status": { "type": "string", "description": "Status of the organization. Valid values include:
  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
" }, "supportedBillingType": { "type": "string", "description": "Developer payment model used for billing. Valid values include:
  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
" }, "taxEngineExternalId": { "type": "string", "description": "External ID for a third-party tax engine." }, "taxModel": { "type": "string", "description": "Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents. Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:
  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.
  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).
  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.
" }, "taxNexus": { "type": "string", "description": "The country in which the organization is registered for tax purposes. Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization." }, "taxRegNo": { "type": "string", "description": "Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents." }, "transactionalRelayURL": { "type": "string", "description": "URL of another system to which transactions can be relayed, such as a data warehouse." }, "timezone": { "type": "string", "description": "The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent." } } }, "parentRatePlan": { "properties": { "advance": { "type": "boolean", "description": "Flag that specifies whether or not the recurring fee is charged in advance. For example, if set to true and the period is 1 month, the recurring fee is charged on the invoice generated when the prior billing month ends. Defaults to false." }, "contractDuration": { "type": "integer", "description": "Length of the contract for the plan together with contractDurationType. For example, to specify a contract duration of 6 months, set contractDuration to 6 and contractDurationType to MONTH." }, "contractDurationType": { "type": "string", "description": "Length of the contract for the plan together with contractDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "currency": { "properties": { "id": { "type": "string", "description": "ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc." } } }, "description": { "type": "string", "description": "Description of the rate plan." }, "developer": { "properties": { "id": { "type": "string", "description": "ID of the developer." }, "legalName": { "type": "string", "description": "Legal name of the developer." }, "name": { "type": "string", "description": "Name of the developer." } } }, "developerCategory": { "properties": { "id": { "type": "string", "description": "ID of the developer category." }, "name": { "type": "string", "description": "Name of the developer category." }, "description": { "type": "string", "description": "Description of the developer category." } } }, "displayName": { "type": "string", "description": "User-friendly display name for the rate plan." }, "earlyTerminationFee": { "type": "integer", "description": "One-time fee that is charged if the developer ends the plan before the renewal term." }, "endDate": { "type": "string", "description": "Date and time that the plan ends in UTC. Uses the following format: YYYY-MM-DD HH:mm:ss. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default. Developers are not able to view the rate plan after this date. If you do not want the rate plan to end on a specific date, specify a null value." }, "freemiumDuration": { "type": "integer", "description": "Period of time for the freemium period together with freemiumDurationType. For example, to specify that the freemium period is 30 days, set freemiumDuration to 30 and freemiumDurationType to DAY." }, "freemiumDurationType": { "type": "string", "description": "Period of time for the freemium period together with freemiumDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumUnit": { "type": "string", "description": "Freemium quantity. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy." }, "frequencyDuration": { "type": "integer", "description": "Together with frequencyDurationType, indicates the period of time between recurring fee charges. For example, to specify that the period of time between fee charges is 30 days, set frequencyDuration to 30 and frequencyDurationTime to DAY." }, "fequencyDurationType": { "type": "string", "description": "Period of time between recurring fee charges. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "id": { "type": "string", "description": "ID of the rate plan." }, "isPrivate": { "type": "boolean", "description": "Flag that specifies whether the rate plan is public or private. Defaults to false (public)." }, "keepOriginalStartDate": { "type": "boolean", "description": "Flag that specifies whether to maintain the start date of the parent rate plan. Defaults to false. Note: This setting applies to future rate plans only." }, "monetizationPackage": { "properties": { "id": { "type": "string", "description": "Name of the API package for the rate plan." } } }, "name": { "type": "string", "description": "Name of the rate plan." }, "organization": { "properties": { "approvedTrusted": { "type": "boolean", "description": "Flag that specifies whether the developer is given approved status by the organization." }, "approvedUntrusted": { "type": "boolean", "description": "Flag that specifies whether untrusted developers are given approved status by the organization." }, "billingCycle": { "type": "string", "description": "Billing cycle period. Valid values include:
  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
" }, "country": { "type": "string", "description": "ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil." }, "currency": { "type": "string", "description": "ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization." }, "description": { "type": "string", "description": "Brief description of the organization." }, "hasBillingAdjustment": { "type": "boolean", "description": "Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products." }, "hasBroker": { "type": "boolean", "description": "Flag that specifies whether the revenue is based on net." }, "hasSelfBilling": { "type": "boolean", "description": "Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer." }, "hasSeparateInvoiceForProduct": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is generated for each API product." }, "id": { "type": "string", "description": "ID of the organization." }, "issueNettingStmt": { "type": "boolean", "description": "Flag that specifies whether a netting statement is generated when creating billing documents." }, "logoUrl": { "type": "string", "description": "URL of the organization's logo." }, "name": { "type": "string", "description": "Name of the organization." }, "netPaymentAdviceNote": { "type": "string", "description": "Net payment advice note." }, "nettingStmtPerCurrency": { "type": "boolean", "description": "Flag that specifies whether a separate netting statement is generated for each currency used." }, "regNo": { "type": "string", "description": "Organization's registration number. The registratino number is displayed at the bottom of billing documents." }, "selfBillingAsExchOrg": { "type": "boolean", "description": "This feature is deprecated." }, "selfBillingForAllDev": { "type": "boolean", "description": "If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider." }, "separateInvoiceForFees": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is published for fees." }, "status": { "type": "string", "description": "Status of the organization. Valid values include:
  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
" }, "supportedBillingType": { "type": "string", "description": "Developer payment model used for billing. Valid values include:
  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
" }, "taxEngineExternalId": { "type": "string", "description": "External ID for a third-party tax engine." }, "taxModel": { "type": "string", "description": "Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents. Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:
  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.
  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).
  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.
" }, "taxNexus": { "type": "string", "description": "The country in which the organization is registered for tax purposes. Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization." }, "taxRegNo": { "type": "string", "description": "Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents." }, "transactionalRelayURL": { "type": "string", "description": "URL of another system to which transactions can be relayed, such as a data warehouse." }, "timezone": { "type": "string", "description": "The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent." } } }, "paymentDueDays": { "type": "integer", "description": "Number of days at which time the fees are due." }, "prorate": { "type": "boolean", "description": "Flag that specifies whether the recurring fee is prorated. This flag pertains to the developer starting or ending the plan part of the way through a month. If set to true, the intial fee is prorated bsed on the number of days until the end of the period or the number of days used in the period. Defaults to false." }, "published": { "type": "boolean", "description": "Flag that specifies whether the rate plan should be published, making it available to developers." }, "ratePlanDetails": { "type": "array", "description": "Details for the rate plan.", "items": { "properties": { "aggregateFreemiumCounters": { "type": "boolean", "description": "Flag that specifies whether or not aggregate counters are enabled to determine if usage of an API product is in the free range. Aggregate counters must be enabled to set up a freemium plan for a product." }, "aggregateStandardCounters": { "type": "boolean", "description": "Flag that specifies whether or not aggregate counters are used to determine the band of usage (such as a volume band for a rate card plan)." }, "currency": { "properties": { "id": { "type": "string", "description": "ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc." } } }, "duration": { "type": "number", "description": "Period of time for the aggregation basis, together with durationType. For example, set duration to 30 and durationType to DAY to specify an aggregation basis of 30 days." }, "durationType": { "type": "string", "description": "Period of time for the aggregation basis, together with durationType. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumDuration": { "type": "integer", "description": "Period of time for the freemium period for an individual API product together with freemiumDurationType. For example, to specify that the freemium period is 30 days, set freemiumDuration to 30 and freemiumDurationType to DAY." }, "freemiumDurationType": { "type": "string", "description": "Period of time for the freemium period for an individual API product together with freemiumDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumUnit": { "type": "string", "description": "Freemium quantity for an API product. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy." }, "meteringType": { "type": "string", "description": "Charging model for a rate card plan. Valid values include: UNIT (flat rate), VOLUME (volume-banded), STAIR_STEP (bundled), or DEV_SPECIFIC (adjustable notification revenue model only)." }, "paymentDueDays": { "type": "number", "description": "Payment due date for a postpaid developer. For example, set the value to 30 to indicate that payment is due in 30 days." }, "ratePlanRates": { "type": "array", "description": "Rate plan rate details, such as the type of rate plan (REVSHARE or RATECARD), the rate for a rate card plan, the revenue share for a revenue share plan, and the range (starting unit and ending unit for which the rate plan rate applies).", "items": { "properties": { "endUnit": { "type": "number", "description": "End unit." }, "id": { "type": "string", "description": "ID of the rate plan rate. Only valid and required when you are updating a draft rate plan rate." }, "rate": { "type": "number", "description": "Rate for the rate card plan. Specify for RATECARD plans only." }, "revshare": { "type": "number", "description": "Revenue share. Specify for REVSHARE plans only." }, "startUnit": { "type": "number", "description": "Start unit." }, "type": { "type": "string", "description": "Type of the rate plan. Valid values include: REVSHARE or RATECARD." } } } }, "ratingParameter": { "type": "string", "description": "Basis for the rate plan. The rate plan is based on transactions or on a custom attribute. Valid values include: VOLUME (based on volume of transactions) or MINT_CUSTOM_ATTRIBUTE_{num}. If you set it to MINT_CUSTOM_ATTRIBUTE_{num}, then the rate plan is based on a custom attribute, where {num} is an integer for example, MINT_CUSTOM_ATTRIBUTE_1. This value is defined in the transaction recording policy for the API product and is valid for rate card plans only. The custom attribute name cannot be defined as VOLUME." }, "ratingParameterUnit": { "type": "string", "description": "Unit that applies to the ratingParameter." }, "revenueType": { "type": "string", "description": "Basis of the revenu share in a revenue share plan. Valid values include: GROSS (based on percentage of the gross price of a transaction) and NET (based on a percentage of the net price of a transaction)." }, "type": { "type": "string", "description": "Revenue model for the plan. Valid values include: REVSHARE, RATECARD, REVSHARE_RATECARD, USAGE_TARGET (adjustable notifications)." } } } }, "recurringFee": { "type": "integer", "description": "Fee that is charged to the developer on an ongoing basis until the developer ends the plan." }, "recurringStartUnit": { "type": "number", "description": "Valid only if recurringType is set to CALENDAR. Day of the month to charge the recurring fee. For example, if the recurring fee is charged monthly and recurringStartUnit is set to 1, the recurring fee is charged on the first day of each month." }, "recurringType": { "type": "string", "description": "Schedule for the recurring fee. Valid values include: CALENDAR or CUSTOM." }, "setUpFee": { "type": "integer", "description": "One-time fee that is charged to each developer on the start date of the plan (that is, the date the developer purchases the plan)." }, "startDate": { "type": "string", "description": "Date and time when the rate plan starts in UTC. Uses the following format: YYYY-MM-DD HH:mm:ss. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default." }, "type": { "type": "string", "description": "Type of rate plan. Valid values include: STANDARD (all developers), DEVELOPER_CATEGORY (developers within a category), or DEVELOPER (specific developer)." } } }, "paymentDueDays": { "type": "integer", "description": "Number of days at which time the fees are due." }, "prorate": { "type": "boolean", "description": "Flag that specifies whether the recurring fee is prorated. This flag pertains to the developer starting or ending the plan part of the way through a month. If set to true, the intial fee is prorated bsed on the number of days until the end of the period or the number of days used in the period. Defaults to false." }, "published": { "type": "boolean", "description": "Flag that specifies whether the rate plan should be published, making it available to developers." }, "ratePlanDetails": { "type": "array", "description": "Details for the rate plan.", "items": { "properties": { "aggregateFreemiumCounters": { "type": "boolean", "description": "Flag that specifies whether or not aggregate counters are enabled to determine if usage of an API product is in the free range. Aggregate counters must be enabled to set up a freemium plan for a product." }, "aggregateStandardCounters": { "type": "boolean", "description": "Flag that specifies whether or not aggregate counters are used to determine the band of usage (such as a volume band for a rate card plan)." }, "currency": { "properties": { "id": { "type": "string", "description": "ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc." } } }, "duration": { "type": "number", "description": "Period of time for the aggregation basis, together with durationType. For example, set duration to 30 and durationType to DAY to specify an aggregation basis of 30 days." }, "durationType": { "type": "string", "description": "Period of time for the aggregation basis, together with durationType. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumDuration": { "type": "integer", "description": "Period of time for the freemium period for an individual API product together with freemiumDurationType. For example, to specify that the freemium period is 30 days, set freemiumDuration to 30 and freemiumDurationType to DAY." }, "freemiumDurationType": { "type": "string", "description": "Period of time for the freemium period for an individual API product together with freemiumDuration. Valid values include: DAY, WEEK, MONTH, QUARTER, or YEAR." }, "freemiumUnit": { "type": "string", "description": "Freemium quantity for an API product. The value can be the number of transactions or the number of units pertaining to a custom attribute recorded in the transaction recording policy." }, "meteringType": { "type": "string", "description": "Charging model for a rate card plan. Valid values include: UNIT (flat rate), VOLUME (volume-banded), STAIR_STEP (bundled), or DEV_SPECIFIC (adjustable notification revenue model only)." }, "paymentDueDays": { "type": "number", "description": "Payment due date for a postpaid developer. For example, set the value to 30 to indicate that payment is due in 30 days." }, "ratePlanRates": { "type": "array", "description": "Rate plan rate details, such as the type of rate plan (REVSHARE or RATECARD), the rate for a rate card plan, the revenue share for a revenue share plan, and the range (starting unit and ending unit for which the rate plan rate applies).", "items": { "properties": { "endUnit": { "type": "number", "description": "End unit." }, "id": { "type": "string", "description": "ID of the rate plan rate. Only valid and required when you are updating a draft rate plan rate." }, "rate": { "type": "number", "description": "Rate for the rate card plan. Specify for RATECARD plans only." }, "revshare": { "type": "number", "description": "Revenue share. Specify for REVSHARE plans only." }, "startUnit": { "type": "number", "description": "Start unit." }, "type": { "type": "string", "description": "Type of the rate plan. Valid values include: REVSHARE or RATECARD." } } } }, "ratingParameter": { "type": "string", "description": "Basis for the rate plan. The rate plan is based on transactions or on a custom attribute. Valid values include: VOLUME (based on volume of transactions) or MINT_CUSTOM_ATTRIBUTE_{num}. If you set it to MINT_CUSTOM_ATTRIBUTE_{num}, then the rate plan is based on a custom attribute, where {num} is an integer for example, MINT_CUSTOM_ATTRIBUTE_1. This value is defined in the transaction recording policy for the API product and is valid for rate card plans only. The custom attribute name cannot be defined as VOLUME." }, "ratingParameterUnit": { "type": "string", "description": "Unit that applies to the ratingParameter." }, "revenueType": { "type": "string", "description": "Basis of the revenue share in a revenue share plan. Valid values include: GROSS (based on percentage of the gross price of a transaction) and NET (based on a percentage of the net price of a transaction)." }, "type": { "type": "string", "description": "Revenue model for the plan. Valid values include: REVSHARE, RATECARD, REVSHARE_RATECARD, USAGE_TARGET (adjustable notifications)." } } } }, "recurringFee": { "type": "integer", "description": "Fee that is charged to the developer on an ongoing basis until the developer ends the plan." }, "recurringStartUnit": { "type": "number", "description": "Valid only if recurringType is set to CALENDAR. Day of the month to charge the recurring fee. For example, if the recurring fee is charged monthly and recurringStartUnit is set to 1, the recurring fee is charged on the first day of each month." }, "recurringType": { "type": "string", "description": "Schedule for the recurring fee. Valid values include: CALENDAR or CUSTOM." }, "setUpFee": { "type": "integer", "description": "One-time fee that is charged to each developer on the start date of the plan (that is, the date the developer purchases the plan)." }, "startDate": { "type": "string", "description": "Date and time when the rate plan starts in UTC. Use the following format: YYYY-MM-DD HH:mm:ss. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default. " }, "type": { "type": "string", "description": "Type of rate plan. Valid values include: STANDARD (all developers), DEVELOPER_CATEGORY (developers within a category), or DEVELOPER (specific developer)." } } } } }

org_name Name of your organization. true

package_id ID of the API package. true

product_id ID of the API product. 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?)