Sales APIs
Create standard recurring price for a product
| HTTP method | POST |
| URI | https://api.rambase.net/product/products/{productId}/standard-recurring-prices |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productId} |
Product identifier
Integer, minimum 10000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4434, version 12 |
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
Required/mandatory field
Three character code following the ISO 4217 standard
Input must match the following regular expression pattern: ^[A-Z]{3}$
>{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>Currency
Required/mandatory field
Three character code following the ISO 4217 standard
Input must match the following regular expression pattern: ^[A-Z]{3}$
": "{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. |
| $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.
StandardRecurringPriceId
Identifier
>{Integer}</StandardRecurringPriceId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status: 3 = future, 4 = active, 9 = discontinued
Possible domain values can be found here
>{Integer}</Status>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>RecurringPriceId
Recurring price identifier
>{Integer}</RecurringPriceId>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PriceInterval
Interval of recurring price
Possible domain values can be found here
>{Integer}</PriceInterval>HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
>{Boolean}</HasOneTimeFee>HasUsage
Boolean indicating if the recurring price has any usage steps.
>{Boolean}</HasUsage>RecurringPriceLink
Recurring price indentifier
>{String}</RecurringPriceLink>PriceStepId
Unique price step identifier
>{Integer}</PriceStepId>Price
Value of a price step
>{Decimal}</Price>PriceStepLink
Price step reference
>{String}</PriceStepLink>PriceListId
Price list identifier
>{Integer}</PriceListId>PriceListLink
Price list reference
>{String}</PriceListLink>EffectiveDate
Date from standard price is valid (for adding in the future)
>{Date}</EffectiveDate>ExpirationDate
Date until standard price is valid (for ending in the future)
>{Date}</ExpirationDate>StandardRecurringPriceId
Identifier of a standard recurring price that is going to be replaced by this price
>{Integer}</StandardRecurringPriceId>StandardRecurringPriceLink
Identifier
>{String}</StandardRecurringPriceLink>LocationId
Location identifier
>{Integer}</LocationId>LocationLink
Location reference
>{String}</LocationLink>StandardRecurringPriceId
Identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status: 3 = future, 4 = active, 9 = discontinued
Possible domain values can be found here
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",RecurringPriceId
Recurring price identifier
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",PriceInterval
Interval of recurring price
Possible domain values can be found here
": "{Integer}",HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
": "{Boolean}",HasUsage
Boolean indicating if the recurring price has any usage steps.
": "{Boolean}",RecurringPriceLink
Recurring price indentifier
": "{String}"PriceStepId
Unique price step identifier
": "{Integer}",Price
Value of a price step
": "{Decimal}",PriceStepLink
Price step reference
": "{String}"PriceListId
Price list identifier
": "{Integer}",PriceListLink
Price list reference
": "{String}"EffectiveDate
Date from standard price is valid (for adding in the future)
": "{Date}",ExpirationDate
Date until standard price is valid (for ending in the future)
": "{Date}"StandardRecurringPriceId
Identifier of a standard recurring price that is going to be replaced by this price
": "{Integer}",StandardRecurringPriceLink
Identifier
": "{String}"LocationId
Location identifier
": "{Integer}",LocationLink
Location reference
": "{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 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. |
| Error 106461 HTTP 400 | Standard recurring price is missing link to recurring price |
| Error 100199 HTTP 404 | Location not found |
| Error 105990 HTTP 400 | Expiriy date of standard recurring price should come after the effective date |