Sales APIs
Update a standard recurring price for a product
| HTTP method | PUT |
| URI | https://api.rambase.net/product/products/{productId}/standard-recurring-prices/{standardRecurringPriceId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productId} |
Product identifier
Integer, minimum 10000 |
| - URI parameter {standardRecurringPriceId} |
Identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4435, version 9 |
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.
StandardRecurringPrice
This field is optional.
>Currency
Three character code following the ISO 4217 standard
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>RecurringPrice
This field is optional.
>RecurringPriceId
Recurring price identifier
Minimum value: 100000
This field is optional.
>{Integer}</RecurringPriceId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>PriceList
This field is optional.
>PriceListId
Price list identifier
Minimum value: 100000
This field is optional.
>{Integer}</PriceListId>Period
This field is optional.
>EffectiveDate
Date from standard price is valid (for adding in the future)
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
Date until standard price is valid (for ending in the future)
This field is optional.
>{Date}</ExpirationDate>ReplacedPrice
This field is optional.
>StandardRecurringPriceId
Identifier of a standard recurring price that is going to be replaced by this price
Minimum value: 100000
This field is optional.
>{Integer}</StandardRecurringPriceId>StandardRecurringPrice
This field is optional.
": {Currency
Three character code following the ISO 4217 standard
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",RecurringPrice
This field is optional.
": {RecurringPriceId
Recurring price identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"PriceList
This field is optional.
": {PriceListId
Price list identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Period
This field is optional.
": {EffectiveDate
Date from standard price is valid (for adding in the future)
This field is optional.
": "{Date}",ExpirationDate
Date until standard price is valid (for ending in the future)
This field is optional.
": "{Date}"ReplacedPrice
This field is optional.
": {StandardRecurringPriceId
Identifier of a standard recurring price that is going to be replaced by this price
Minimum value: 100000
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. |
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 102738 HTTP 404 | Price list not found |
| Error 106460 HTTP 400 | Standard recurring price can get higher status only if it is linked to an active recurring price |
| Error 106461 HTTP 400 | Standard recurring price is missing link to recurring price |
| Error 105990 HTTP 400 | Expiriy date of standard recurring price should come after the effective date |