API

Sales APIs

POST product/products/{productId}/standard-recurring-prices

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.

Format:
1
<StandardRecurringPrice>
2
     <Currency
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>
3
     <RecurringPrice
RecurringPrice

This field is optional.

>
4
          <RecurringPriceId
RecurringPriceId

Recurring price identifier

Minimum value: 100000

This field is optional.

>{Integer}</RecurringPriceId>
5
     </RecurringPrice>
6
     <Location
Location

This field is optional.

>
7
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
8
     </Location>
9
     <PriceList
PriceList

This field is optional.

>
10
          <PriceListId
PriceListId

Price list identifier

Minimum value: 100000

This field is optional.

>{Integer}</PriceListId>
11
     </PriceList>
12
     <Period
Period

This field is optional.

>
13
          <EffectiveDate
EffectiveDate

Date from standard price is valid (for adding in the future)

This field is optional.

>{Date}</EffectiveDate>
14
          <ExpirationDate
ExpirationDate

Date until standard price is valid (for ending in the future)

This field is optional.

>{Date}</ExpirationDate>
15
     </Period>
16
     <ReplacedPrice
ReplacedPrice

This field is optional.

>
17
          <StandardRecurringPriceId
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>
18
     </ReplacedPrice>
19
</StandardRecurringPrice>
1
{
2
     "standardRecurringPrice": {
3
          "currency
Currency

Required/mandatory field

Three character code following the ISO 4217 standard

Input must match the following regular expression pattern: ^[A-Z]{3}$

": "{String}",
4
          "recurringPrice
RecurringPrice

This field is optional.

": {
5
               "recurringPriceId
RecurringPriceId

Recurring price identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
6
          },
7
          "location
Location

This field is optional.

": {
8
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
9
          },
10
          "priceList
PriceList

This field is optional.

": {
11
               "priceListId
PriceListId

Price list identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
12
          },
13
          "period
Period

This field is optional.

": {
14
               "effectiveDate
EffectiveDate

Date from standard price is valid (for adding in the future)

This field is optional.

": "{Date}",
15
               "expirationDate
ExpirationDate

Date until standard price is valid (for ending in the future)

This field is optional.

": "{Date}"
16
          },
17
          "replacedPrice
ReplacedPrice

This field is optional.

": {
18
               "standardRecurringPriceId
StandardRecurringPriceId

Identifier of a standard recurring price that is going to be replaced by this price

Minimum value: 100000

This field is optional.

": "{Integer}"
19
          }
20
     }
21
}

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.
$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.

Format:
1
1

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 105990 HTTP 400 Expiriy date of standard recurring price should come after the effective date