Pricing¶
Optional. Leave it out for internal sharing. pricing is a list of plans on project (applies to every dataset) or
on a dataset (replaces the project's; pricing: [] means none for that dataset). Every field is optional. The fields
follow the pricing plans of ODPS 4.1, plus price_unit from ODCS. List the main plan first: the first priced plan
also fills an ODCS contract's single price (see mappings).
Example¶
pricing:
- name: Standard API
unit: Pay-per-use
price: '0.01'
price_currency: USD
price_unit: request
billing_duration: month
max_transaction_quantity: 200000
additional_price: '0.012'
- name: Community
unit: Freemium
Definitions¶
| Key | Type | Required | Priority | Check | Description |
|---|---|---|---|---|---|
pricing[].name |
string | no | None | - | Plan name. |
pricing[].unit |
One-time-payment, Pay-per-use, Recurring, Revenue-sharing, Data-volume, Pay-what-you-want, Freemium, Open-data, Value-based, On-request, Trial |
no | None | error on any other value | The kind of plan. |
pricing[].price |
string or number | no | None | error unless an amount (digits, . as decimal point; not negative); quote it |
Price per price_unit or billing_duration; for Revenue-sharing, the percentage. Hint if there is no price_currency (not for free units or On-request). |
pricing[].price_currency |
string | no | None | error unless a code of 3 to 5 letters or percentage (case is normalised); error if not percentage on a Revenue-sharing plan |
ISO 4217 code, crypto ticker, or percentage. |
pricing[].price_unit |
string | no | None | hint if absent on Pay-per-use |
What one use is: request, row, GB. |
pricing[].billing_duration |
instant, day, week, month, year |
no | None | error on any other value; hint if absent on Recurring |
How long one price is billed for. |
pricing[].max_transaction_quantity |
integer >= 0 | no | None | error if negative | Uses allowed per billing_duration; 0 is unlimited. |
pricing[].additional_price |
string or number | no | None | amount rule as price; hint if max_transaction_quantity is not set |
Price per use above the quota. |
pricing[].max_data_quantity |
integer >= 0 | no | None | error if negative | GB allowed per billing_duration. |
pricing[].min_price |
string or number | no | None | amount rule; error if above max_price |
Lowest price when the price is a range. |
pricing[].max_price |
string or number | no | None | amount rule | Highest price when the price is a range. |
pricing[].offering |
list of string | no | None | - | What the plan includes. |
pricing[].valid_from |
date | no | None | error if after valid_to |
Start of validity. |
pricing[].valid_to |
date | no | None | as above | End of validity. |
pricing[].notes |
string | no | None | - | Free note. |