API

Sales APIs

GET sales/recurring-prices

List of recurring prices

HTTP method GET
URI https://api.rambase.net/sales/recurring-prices
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4342, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active recurring prices
Draft() Named filter Draft recurring prices
Currency String Three character code following the ISO 4217 standard.
MinimumPaymentPeriods Integer Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before.
PriceInterval Integer Interval of recurring price.
RecurringPriceId Integer Recurring price indentifier.
Status Integer Status of recurring price.
UsageInterval Integer Interval of usage.

Read more about filters and sorting on how to use sortable parameters

Currency String Three character code following the ISO 4217 standard
MinimumPaymentPeriods Integer Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before
PriceInterval Integer Interval of recurring price
RecurringPriceId Integer Recurring price indentifier
Status Integer Status of recurring price
UsageInterval Integer Interval of usage

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<RecurringPrices>
2
     <RecurringPrice>
3
          <RecurringPriceId
RecurringPriceId

Recurring price indentifier

>{Integer}</RecurringPriceId>
4
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
          <Status
Status

Status of recurring price

Possible domain values can be found here

>{Integer}</Status>
6
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
7
          <PriceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

>{Integer}</PriceInterval>
8
          <UsageInterval
UsageInterval

Interval of usage

Possible domain values can be found here

>{Integer}</UsageInterval>
9
          <UsageUnit>
10
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
11
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
12
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
13
          </UsageUnit>
14
          <MinimumBillingPeriods
MinimumBillingPeriods

Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before

>{Integer}</MinimumBillingPeriods>
15
          <HasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

>{Boolean}</HasOneTimeFee>
16
          <HasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

>{Boolean}</HasUsageStep>
17
          <RecurringPriceLink
RecurringPriceLink

Recurring price reference

>{String}</RecurringPriceLink>
18
     </RecurringPrice>
19
     <Paging
Paging

Detailed paging information for this list.

>
20
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
21
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
22
          <Page
Page

Page index

>{Integer}</Page>
23
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
24
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
25
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
26
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
27
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
28
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
29
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
30
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
31
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
32
     </Paging>
33
</RecurringPrices>
1
{
2
     "recurringPrices": [
3
          {
4
               "recurringPriceId
RecurringPriceId

Recurring price indentifier

": "{Integer}",
5
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
               "status
Status

Status of recurring price

Possible domain values can be found here

": "{Integer}",
7
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
8
               "priceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

": "{Integer}",
9
               "usageInterval
UsageInterval

Interval of usage

Possible domain values can be found here

": "{Integer}",
10
               "usageUnit": {
11
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
12
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
13
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
14
               },
15
               "minimumBillingPeriods
MinimumBillingPeriods

Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before

": "{Integer}",
16
               "hasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

": "{Boolean}",
17
               "hasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

": "{Boolean}",
18
               "recurringPriceLink
RecurringPriceLink

Recurring price reference

": "{String}"
19
          }
20
     ],
21
     "paging
Paging

Detailed paging information for this list.

": {
22
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
23
          "position
Position

Position of the first element in the list

": "{Integer}",
24
          "page
Page

Page index

": "{Integer}",
25
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
26
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
27
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
28
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
29
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
30
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
31
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
32
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
33
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
34
     }
35
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}