Skip to content

Commit

Permalink
sum
Browse files Browse the repository at this point in the history
  • Loading branch information
kyyberi committed Mar 26, 2024
1 parent d59b631 commit 6f702cd
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 79 deletions.
37 changes: 37 additions & 0 deletions source/includes/_pricing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,40 @@

Pricing components


##

**Optional attributes and elements**

> Example of Pricing component usage with some of the optional elements and attributes:
```yml

pricingPlans:
- name: Premium subscription 1 year
priceCurrency: EUR
price: 10.00
x-standardized:
minPrice: 5.00
maxPrice: 15.000
additionalPrice: 0.02
- name: Premium Package
priceCurrency: EUR
price: 10.00
x-standardized:
maxPrice: 20.00
valueAddedTaxIncluded: False

```

| <div style="width:150px">Element name</div> | Type | Options | Description |
|---|---|---|---|
| minPrice | string | - | The lowest price if the price is a range. If dynamic pricing is used with this product, this is the lowest price allowed. In dynamic pricing businesses are able to change prices based on algorithms that take into account competitor pricing, supply and demand, and other external factors in the market. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| maxPrice | string | - | The highest price if the price is a range. If dynamic pricing is used with this product, this is the highest price allowed. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| valueAddedTaxIncluded | boolean | true/false | Specifies whether the applicable value-added tax (VAT) is included in the price specification or not. |
| valueAddedTaxPercentage | Integer | Number percentage value, range 0-100 | Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| validFrom | DateTime | A combination of date and time in [ISO 8601](https://www.ionos.com/digitalguide/websites/web-development/iso-8601/) format yyyy-MM-dd'T'HH:mm:ss.SSSZ. | The date when the item becomes valid. |
| validTo | DateTime | A combination of date and time in [ISO 8601](https://www.ionos.com/digitalguide/websites/web-development/iso-8601/) format yyyy-MM-dd'T'HH:mm:ss.SSSZ. | The date after when the item is not valid. |
| additionalPrice | string | - | This is used to define fees for usage which exceeds the defined max transaction quantity. This value is for each additional transaction. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| maxDataQuantity | Integer | - | The maximum amount of data transferred during the billing duration. Unit is GB. |
| valueSimulator | url | valid url | Intended to be used with *value-based* pricing plan. Provide url to value simulator in which customer can see the value in various cases. In the simulator customer might be able to input own variables to match their exact case and see the gained value. |
100 changes: 21 additions & 79 deletions source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ x-standardized:
## Data Quality
Data quality extensions defined separately.
## Pricing
Pricing is the process whereby a business sets the price at which it will sell its products and services. Pricing **OBJECT** consists of mandatory and optional attributes. This element contains pricing plans related data to be used for example in displaying the items in a marketplace or as part of a data contract.
Expand All @@ -96,52 +93,31 @@ Supported pricing models include:
**Mandatory attributes and elements**
> Example of Pricing component usage with manadatory elements and attributes. Example language is english.:
> Example of Pricing component usage with manadatory elements and attributes:
```yml

pricingPlans:
en:
- name: Premium subscription 1 year
priceCurrency: EUR
price: 50.00
billingDuration: year
unit: recurring
maxTransactionQuantity: unlimited
offering:
- High Quality Pets data
- Unlimited transactions
- Billed annually
- name: Premium Package Monthly
priceCurrency: EUR
price: 5.00
billingDuration: month
unit: recurring
maxTransactionQuantity: unlimited
offering:
- High Quality Pets data
- Unlimited transactions
- Billed monthly
- name: Freemium Package
priceCurrency: EUR
price: 0.00
billingDuration: month
unit: recurring
maxTransactionQuantity: 1000
offering:
- High Quality Pets data
- Free to use, no cost at all!
- Fair amount of transactions for testing and small business
- name: Revenue sharing
priceCurrency: percentage
price: 5.50
billingDuration: month
unit: revenue-sharing
maxTransactionQuantity: 20000
offering:
- High Quality Pets data
- No upfront fee
- Billed monthly
- name: Premium subscription 1 year
priceCurrency: EUR
price: 50.00
billingDuration: year
unit: recurring
maxTransactionQuantity: unlimited
offering:
- High Quality Pets data
- Unlimited transactions
- Billed annually
- name: Premium Package Monthly
priceCurrency: EUR
price: 5.00
billingDuration: month
unit: recurring
maxTransactionQuantity: unlimited
offering:
- High Quality Pets data
- Unlimited transactions
- Billed monthly

```

Expand All @@ -156,40 +132,6 @@ pricingPlans:
| **maxTransactionQuantity** | Integer | Integer | **REQUIRED** The maximum transaction quantity for the given billing duration. Use this to define for example monthly (or any other period) request limit to the data product. Note! If you want to set unlimited use, value must be 0 (zero). |
| **offering** | string | array | **REQUIRED** The element that contains pricing plan content as array of strings. Think of this as the list of what is included in the pricing plan and what you offer in return to the price asked. Use the language defined in the *plan* |

**Optional attributes and elements**

> Example of Pricing component usage with some of the optional elements and attributes:
```yml

pricingPlans:
en:
- name: Premium subscription 1 year
priceCurrency: EUR
price: 10.00
minPrice: 5.00
maxPrice: 15.000
additionalPrice: 0.02
- name: Premium Package
priceCurrency: EUR
price: 10.00
maxPrice: 20.00
valueAddedTaxIncluded: False

```

| <div style="width:150px">Element name</div> | Type | Options | Description |
|---|---|---|---|
| minPrice | string | - | The lowest price if the price is a range. If dynamic pricing is used with this product, this is the lowest price allowed. In dynamic pricing businesses are able to change prices based on algorithms that take into account competitor pricing, supply and demand, and other external factors in the market. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| maxPrice | string | - | The highest price if the price is a range. If dynamic pricing is used with this product, this is the highest price allowed. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| valueAddedTaxIncluded | boolean | true/false | Specifies whether the applicable value-added tax (VAT) is included in the price specification or not. |
| valueAddedTaxPercentage | Integer | Number percentage value, range 0-100 | Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| validFrom | DateTime | A combination of date and time in [ISO 8601](https://www.ionos.com/digitalguide/websites/web-development/iso-8601/) format yyyy-MM-dd'T'HH:mm:ss.SSSZ. | The date when the item becomes valid. |
| validTo | DateTime | A combination of date and time in [ISO 8601](https://www.ionos.com/digitalguide/websites/web-development/iso-8601/) format yyyy-MM-dd'T'HH:mm:ss.SSSZ. | The date after when the item is not valid. |
| additionalPrice | string | - | This is used to define fees for usage which exceeds the defined max transaction quantity. This value is for each additional transaction. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols. |
| maxDataQuantity | Integer | - | The maximum amount of data transferred during the billing duration. Unit is GB. |
| valueSimulator | url | valid url | Intended to be used with *value-based* pricing plan. Provide url to value simulator in which customer can see the value in various cases. In the simulator customer might be able to input own variables to match their exact case and see the gained value. |


## Provider

Expand Down

0 comments on commit 6f702cd

Please sign in to comment.