# CreatePriceRequest

## Example Usage

```typescript
import { CreatePriceRequest } from "@flexprice/sdk/sdk/models";

let value: CreatePriceRequest = {
  billingModel: "PACKAGE",
  billingPeriod: "ANNUAL",
  currency: "Swedish Krona",
  entityId: "<id>",
  entityType: "COSTSHEET",
  invoiceCadence: "ADVANCE",
  priceUnitType: "FIAT",
  type: "FIXED",
};
```

## Fields

| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `billingModel`                                                                                | [models.BillingModel](../../sdk/models/billing-model.md)                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `billingPeriod`                                                                               | [models.BillingPeriod](../../sdk/models/billing-period.md)                                    | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `billingPeriodCount`                                                                          | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `currency`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `description`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `displayName`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `entityId`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `entityType`                                                                                  | [models.PriceEntityType](../../sdk/models/price-entity-type.md)                               | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `filterValues`                                                                                | Record<string, *string*[]>                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `groupId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | GroupID is the id of the group to add the price to                                            |
| `invoiceCadence`                                                                              | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md)                                  | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `lookupKey`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `meterId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `minQuantity`                                                                                 | *number*                                                                                      | :heavy_minus_sign:                                                                            | MinQuantity is the minimum quantity of the price                                              |
| `priceUnitConfig`                                                                             | [models.PriceUnitConfig](../../sdk/models/price-unit-config.md)                               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `priceUnitType`                                                                               | [models.PriceUnitType](../../sdk/models/price-unit-type.md)                                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `tierMode`                                                                                    | [models.BillingTier](../../sdk/models/billing-tier.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `tiers`                                                                                       | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]                             | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `transformQuantity`                                                                           | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md)                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `trialPeriodDays`                                                                             | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
| `type`                                                                                        | [models.PriceType](../../sdk/models/price-type.md)                                            | :heavy_check_mark:                                                                            | N/A                                                                                           |