## Retrieve Rate Schedule

`v1.contracts.retrieve_rate_schedule(**kwargs) -> ContractRetrieveRateScheduleResponse`

**post** `/v1/contracts/getContractRateSchedule`

Get the rate schedule for the rate card on a given contract.

### Parameters

- **contract\_id:** `String`

  ID of the contract to get the rate schedule for.

- **customer\_id:** `String`

  ID of the customer for whose contract to get the rate schedule for.

- **limit:** `Integer`

  Max number of results that should be returned

- **next\_page:** `String`

  Cursor that indicates where the next page of results should start.

- **at:** `Time`

  optional timestamp which overlaps with the returned rate schedule segments. When not specified, the current timestamp will be used.

- **selectors:** `Array[{ billing_frequency, partial_pricing_group_values, pricing_group_values, 2 more}]`

  List of rate selectors, rates matching ANY of the selectors will be included in the response. Passing no selectors will result in all rates being returned.

  - **billing\_frequency:** `:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY`

    Subscription rates matching the billing frequency will be included in the response.

    - `:MONTHLY`

    - `:QUARTERLY`

    - `:ANNUAL`

    - `:WEEKLY`

  - **partial\_pricing\_group\_values:** `Hash[Symbol, String]`

    List of pricing group key value pairs, rates containing the matching key / value pairs will be included in the response.

  - **pricing\_group\_values:** `Hash[Symbol, String]`

    List of pricing group key value pairs, rates matching all of the key / value pairs will be included in the response.

  - **product\_id:** `String`

    Rates matching the product id will be included in the response.

  - **product\_tags:** `Array[String]`

    List of product tags, rates matching any of the tags will be included in the response.

### Returns

- `class ContractRetrieveRateScheduleResponse`

  - **data:** `Array[{ entitled, list_rate, product_custom_fields, 10 more}]`

    - **entitled:** `bool`

    - **list\_rate:** `Rate`

    - **product\_custom\_fields:** `Hash[Symbol, String]`

    - **product\_id:** `String`

    - **product\_name:** `String`

    - **product\_tags:** `Array[String]`

    - **rate\_card\_id:** `String`

    - **starting\_at:** `Time`

    - **billing\_frequency:** `:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY`

      - `:MONTHLY`

      - `:QUARTERLY`

      - `:ANNUAL`

      - `:WEEKLY`

    - **commit\_rate:** `{ rate_type, price, tiers}`

      A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.

      - **rate\_type:** `:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more`

        - `:FLAT`

        - `:PERCENTAGE`

        - `:SUBSCRIPTION`

        - `:TIERED`

        - `:CUSTOM`

      - **price:** `Float`

        Commit rate price. For FLAT rate_type, this must be >=0.

      - **tiers:** `Array[Tier]`

        Only set for TIERED rate_type.

        - **price:** `Float`

        - **size:** `Float`

    - **ending\_before:** `Time`

    - **override\_rate:** `Rate`

    - **pricing\_group\_values:** `Hash[Symbol, String]`

  - **next\_page:** `String`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.contracts.retrieve_rate_schedule(
  contract_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d"
)

puts(response)
```