RateplanRates
Schema
endUnit | End unit. |
id | ID of the rate plan rate. Only valid and required when you are updating a draft rate plan rate. |
rate | Rate for the rate card plan. Specify for RATECARD plans only. |
revshare | Revenue share. Specify for REVSHARE plans only. |
startUnit | Start unit. |
type | Type of the rate plan. Valid values include: |
Paths
The following paths use this type:
Lists rate plans accepted by a developer. See also Viewing all rate plans accepted by a developer using the API.
Lists active rate plans for a developer. See also Viewing all active rate plans for a developer using the API.
Accept a published rate plan for a developer. See also Accept published rate plans using the API.
Gets an active rate plan for a developer. See also Viewing an active rate plan for a developer using the API.
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.
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.
Lists rate plans for an API package. See also Viewing rate plans using the API.
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:
- Set a one-time or recurring fee for the plan
- Add a freemium part to the plan enabling devleopers to try out features for free over a period of time
- Configure a rate plan type, such as revenue share, rate card, or combination
- Set a renewal period
- Define product-specific plans, if desired
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.
Gets a rate plan for an API package. See also Viewing a rate plan for an API package using the API.
Update a rate plan for an API package. See also Editing a rate plan draft using the API.
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).
'Lists rate plans for your organization. See also Viewing rate plans using the API.