> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Rate Plan Object

## Attributes

| Name | Type | Description |
| - | - | - |
| object | string | Value is “RatePlan” |
| id | string | A merchant-specified unique identifier. Optionally, this object can be identified by its vid. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe. |
| created | datetime | The date/time the object was created. |
| description | string | Optional description of the rated service offering. |
| multiply\_rated\_units\_by | enum | Tier pricing rule. EachRespective charges units “in” that tier at its price; `HighestApplicable` is volume pricing, charging at the peak unit level’s tier for all units. Values can be `EachRespectiveTier`, `HighestApplicableTier` |
| rated\_unit | [Rated Unit](Rated_Unit) | Defined rating unit of measure. |
| tier | [Rate Plan Tier](Rate_Plan_Tier) | Successive pricing tiers based on unit “from/to” limits |
| rounding\_decimals | integer | Number of digits for rounding; Excel’s ROUND function: 0 = nearest integer, 2 = 2 decimal places, -2 means = nearest hundred, etc. |
| included\_units | decimal | Number of units included for free; tier 1 starts after included units have been recorded. |
| minimum\_fee | [Rate Plan Price](Rate_Plan_Price) | Minimum charge per billing period (one price per currency) |
| maximum\_fee | [Rate Plan Price](Rate_Plan_Price) | Maximum charge per billing period (one price per currency) |
| rate\_plan\_model | enum | Determines pre-paid (licenses or seats billed in advance) or post-paid (usage recorded throughout the period and billed at period end. Values can be `LicenseBased`, `UsageBased` |
| status | enum | Merchants may define whether they want to declare a plan as available to offer. Values can be `Active`, `Suspended` |
| has\_event\_recorded | boolean | Read-only field that tells whether this RatePlan has had any events recorded on it or not. |
| metadata | hash | A set of key/value pairs that you can attach to an object. Useful for storing additional information. |

## Example Object

```

{
   "object":"RatePlan",
   "id":"rateplan_1234",
   "vid":"90f519aca94d5ea79dbc6512fade7a7f09a8e214",
   "description":"Combo:  Each, Usage, Flat1",
   "multiply_rated_units_by":"EachRespectiveTier",
   "rated_unit":{
      "object":"RatedUnit",
      "name_singular":"License",
      "name_plural":"Licenses"
   },
   "tier":[
      {
         "object":"RatePlanTier",
         "name":"Tier 1",
         "rate_price":[
            {
               "object":"RatePlanPrice",
               "amount":11,
               "currency":"USD"
            }
         ],
         "charge_customer":"FlatFee",
         "begins_at_level":1
      },
      {
         "object":"RatePlanTier",
         "name":"Tier 2",
         "rate_price":[
            {
               "object":"RatePlanPrice",
               "amount":5,
               "currency":"USD"
            }
         ],
         "charge_customer":"FlatFee",
         "begins_at_level":11
      }
   ],
   "rounding_decimals":0,
   "included_units":0,
   "minimum_fee":[
      {
         "object":"RatePlanPrice",
         "amount":0,
         "currency":"USD"
      }
   ],
   "maximum_fee":[],
   "rate_plan_model":"UsageBased",
   "status":"Active",
   "has_event_recorded":true
}
```

**Parent topic:**[Rate Plans](../topics/Rate_Plans)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.