Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R6.0.0

Excerpt

This method creates a buy in advance request. A single buy in advance request can be created by each call.

...

Resource URL

Parameters

Name

Type

Description

 

token

String

The token retrieved from the login method

 
subscription_identifier
(mandatory)
 Subscription IdentifierThe identifier of the subscription related with the buy in advance request. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

 

duration

(mandatory)

NumberThe duration that is requested to be bough in advance 

unit_of_time

(mandatory)

StringThe unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS 

description

(optional)

StringA description of the retrieved buy in advance request 

billing_effective_date

(optional)

DateThe billing effective date of the buy in advance request, that determines the earliest date that the request can be picked up by the billing engine. If not specified then it is automatically set to the date that the request is submitted  

udf_string_1
(optional)

String

User Defined Field of type String

 

udf_string_2
(optional)

String

User Defined Field of type String

 

udf_string_3
(optional)

String

User Defined Field of type String

 

udf_string_4
(optional)

String

User Defined Field of type String

 

udf_string_5
(optional)

String

User Defined Field of type String

 

udf_string_6
(optional)

String

User Defined Field of type String

 

udf_string_7
(optional)

String

User Defined Field of type String

 

udf_string_8
(optional)

String

User Defined Field of type String

 

udf_float_1
(optional)

Float

User Defined Field of type Float

 

udf_float_2
(optional)

Float

User Defined Field of type Float

 

udf_float_3
(optional)

Float

User Defined Field of type Float

 

udf_float_4
(optional)

Float

User Defined Field of type Float

 

udf_date_1
(optional)

Date

User Defined Field of type Date

 

udf_date_2
(optional)

Date

User Defined Field of type Date

 

udf_date_3
(optional)

Date

User Defined Field of type Date

 

udf_date_4
(optional)

Date

User Defined Field of type Date

 

services_set

(optional)

Set of Buy in advance request services

A set of services which are bough in advance through this request. Applicable only for prepaid subscriptions and only for such subscriptions' pre-rated services

Tip

Available from CRM.COM R12.0.0

 

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

 

...