# ContractApi All URIs are relative to *https://api.ionos.com/cloudapi/v5* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**contracts_get**](ContractApi.md#contracts_get) | **GET** /contracts | Retrieve a Contract | ## contracts_get > <Contract> contracts_get(opts) Retrieve a Contract Retrieves the attributes of user's contract. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::ContractApi.new opts = { pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed } begin # Retrieve a Contract result = api_instance.contracts_get(opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling ContractApi->contracts_get: #{e}" end ``` #### Using the contracts_get_with_http_info variant This returns an Array which contains the response data, status code and headers. > <Array(<Contract>, Integer, Hash)> contracts_get_with_http_info(opts) ```ruby begin # Retrieve a Contract data, status_code, headers = api_instance.contracts_get_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => <Contract> rescue Ionoscloud::ApiError => e puts "Error when calling ContractApi->contracts_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] | | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] | | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] | ### Return type [**Contract**](Contract.md) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json