Sales APIs
Update specific price step
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/recurring-prices/{recurringPriceId}/price-steps/{priceStepId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {recurringPriceId} |
Recurring price indentifier
Integer, minimum 100000 |
| - URI parameter {priceStepId} |
Unique price step identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 4365, version 4 |
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.
PriceStep
This field is optional.
>Price
Value of a price step
Minimum value: 0
This field is optional.
>{Decimal}</Price>FromQuantity
Beginning quantity of the price step
Minimum value: 1
This field is optional.
>{Integer}</FromQuantity>FromInterval
Beginning day of a price step
Minimum value: 1
This field is optional.
>{Integer}</FromInterval>ApplicableDays
Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when PRICEINTERVAL is set to "DAY"
This field is optional.
>ApplicableDay
This field is optional.
>Day
Date of the day
Applicable domain values can be found here
This field is optional.
>{String}</Day>PriceStep
This field is optional.
": {Price
Value of a price step
Minimum value: 0
This field is optional.
": "{Decimal}",FromQuantity
Beginning quantity of the price step
Minimum value: 1
This field is optional.
": "{Integer}",FromInterval
Beginning day of a price step
Minimum value: 1
This field is optional.
": "{Integer}",ApplicableDays
Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when PRICEINTERVAL is set to "DAY"
This field is optional.
": [Day
Date of the day
Applicable domain values can be found here
This field is optional.
": "{String}"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. |
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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 105720 HTTP 400 | Days can only be set when price interval is set as day. |
| Error 105770 HTTP 400 | From day should be greater than zero. |
| Error 105771 HTTP 400 | From quantity value should be greater than zero. |
| Error 105769 HTTP 400 | Step price should not be a negative. |
| Error 106447 HTTP 400 | Select at least one day for the price step |
| Error 105930 HTTP 400 | The quantity and interval has already been added. |