Sales APIs
Creates a new recurring price
| HTTP method | POST |
| URI | https://api.rambase.net/sales/recurring-prices |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 4348, version 8 |
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.
Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>PriceInterval
Required/mandatory field
Interval of recurring price
Applicable domain values can be found here
>{Integer}</PriceInterval>UsageInterval
Interval of usage
Applicable domain values can be found here
This field is optional.
>{Integer}</UsageInterval>UsageUnit
This field is optional.
>MeasurementUnitId
Measurement unit identifier
Minimum value: 100
This field is optional.
>{Integer}</MeasurementUnitId>MinimumBillingPeriods
Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before
Minimum value: 1
This field is optional.
>{Integer}</MinimumBillingPeriods>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",PriceInterval
Required/mandatory field
Interval of recurring price
Applicable domain values can be found here
": "{Integer}",UsageInterval
Interval of usage
Applicable domain values can be found here
This field is optional.
": "{Integer}",UsageUnit
This field is optional.
": {MeasurementUnitId
Measurement unit identifier
Minimum value: 100
This field is optional.
": "{Integer}"MinimumBillingPeriods
Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before
Minimum value: 1
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RecurringPriceId
Recurring price indentifier
>{Integer}</RecurringPriceId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>PriceInterval
Interval of recurring price
Possible domain values can be found here
>{Integer}</PriceInterval>UsageInterval
Interval of usage
Possible domain values can be found here
>{Integer}</UsageInterval>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>MinimumBillingPeriods
Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before
>{Integer}</MinimumBillingPeriods>HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
>{Boolean}</HasOneTimeFee>HasUsageStep
Boolean indicating if the recurring price has any usage steps.
>{Boolean}</HasUsageStep>RecurringPriceId
Recurring price indentifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of recurring price
Possible domain values can be found here
": "{Integer}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",PriceInterval
Interval of recurring price
Possible domain values can be found here
": "{Integer}",UsageInterval
Interval of usage
Possible domain values can be found here
": "{Integer}",MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"MinimumBillingPeriods
Minimum number of periods customer is going to be charged, even if the actual return of rented objects occurs before
": "{Integer}",HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
": "{Boolean}",HasUsageStep
Boolean indicating if the recurring price has any usage steps.
": "{Boolean}"
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 105975 HTTP 400 | Recurring price cannot be updated in other status than status 1 |
| Error 105785 HTTP 400 | Minimum billing period should be greater than 0. |