API

Sales APIs

POST sales/recurring-prices/{recurringPriceId}/usage-steps

Create usage step for the recurring price

HTTP method POST
URI https://api.rambase.net/sales/recurring-prices/{recurringPriceId}/usage-steps
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 4370, 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.

Format:
1
<UsageStep>
2
     <FromQuantity
FromQuantity

Required/mandatory field

Beginning quantity of the usage step

Minimum value: 1

>{Integer}</FromQuantity>
3
     <Price
Price

Required/mandatory field

Value of a usage step

Minimum value: 0

>{Decimal}</Price>
4
     <ApplicableDays
ApplicableDays

Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when USAGEINTERVAL is set to "DAY"

This field is optional.

>
5
          <ApplicableDay
ApplicableDay

This field is optional.

>
6
               <Day
Day

Date of the day

Applicable domain values can be found here

This field is optional.

>{String}</Day>
7
          </ApplicableDay>
8
     </ApplicableDays>
9
</UsageStep>
1
{
2
     "usageStep": {
3
          "fromQuantity
FromQuantity

Required/mandatory field

Beginning quantity of the usage step

Minimum value: 1

": "{Integer}",
4
          "price
Price

Required/mandatory field

Value of a usage step

Minimum value: 0

": "{Decimal}",
5
          "applicableDays
ApplicableDays

Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when USAGEINTERVAL is set to "DAY"

This field is optional.

": [
6
               {
7
                    "day
Day

Date of the day

Applicable domain values can be found here

This field is optional.

": "{String}"
8
               }
9
          ]
10
     }
11
}

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.

Format:
1
<UsageStep>
2
     <UsageStepId
UsageStepId

Usage entry identifier

>{Integer}</UsageStepId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
5
     <FromQuantity
FromQuantity

Beginning quantity of the usage step

>{Integer}</FromQuantity>
6
     <Price
Price

Value of a usage step

>{Decimal}</Price>
7
     <ApplicableDays
ApplicableDays

Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when USAGEINTERVAL is set to "DAY"

>
8
          <ApplicableDay>
9
               <Day
Day

Date of the day

Possible domain values can be found here

>{String}</Day>
10
          </ApplicableDay>
11
     </ApplicableDays>
12
</UsageStep>
1
{
2
     "usageStep": {
3
          "usageStepId
UsageStepId

Usage entry identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
6
          "fromQuantity
FromQuantity

Beginning quantity of the usage step

": "{Integer}",
7
          "price
Price

Value of a usage step

": "{Decimal}",
8
          "applicableDays
ApplicableDays

Comma separated list defining days of the week (mon, tue, fri etc.). Should only be filled when USAGEINTERVAL is set to "DAY"

": [
9
               {
10
                    "day
Day

Date of the day

Possible domain values can be found here

": "{String}"
11
               }
12
          ]
13
     }
14
}

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 105939 HTTP 400 Usage price should not be negative.
Error 105940 HTTP 400 Usage quantity should not be negative.
Error 106610 HTTP 400 Usage interval is required
Error 106207 HTTP 400 Usage step definition is not unique