Sales APIs
Create one time fee for the recurring price
| HTTP method | POST |
| URI | https://api.rambase.net/sales/recurring-prices/{recurringPriceId}/one-time-fees |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {recurringPriceId} |
Recurring price indentifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4356, version 3 |
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.
Price
One time fee price
Minimum value: 0
This field is optional.
>{Decimal}</Price>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>Type
Required/mandatory field
Either start, deposit or end.
Applicable domain values can be found here
>{Integer}</Type>Price
One time fee price
Minimum value: 0
This field is optional.
": "{Decimal}",ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"Type
Required/mandatory field
Either start, deposit or end.
Applicable domain values can be found here
": "{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.
OneTimeFeeId
Unique one time fee identifier
>{Integer}</OneTimeFeeId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Price
One time fee price
>{Decimal}</Price>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product identifier
>{String}</ProductLink>OneTimeFeeId
Unique one time fee identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Price
One time fee price
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Type
Either start, deposit or end.
Possible domain values can be found here
": "{Integer}",ProductId
Product identifier
": "{Integer}",Status
Status of the product
Possible domain values can be found here
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product identifier
": "{String}"
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 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 102747 HTTP 400 | Error in formula: {0} |