Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Excerpt

This method returns information related with subscriptions owned by the same accounts receivable. Multiple

...

subscriptions are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(semi-optional)

Contact Information identifier  

The identifier of the contact information related with the subscription that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

Tip

Available from CRM.COM R14.0.0

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier  

The identifier of the accounts receivable owning the subscriptions that will be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

wallet_identifier

(semi-optional)

Wallet identifier  

The identifier of the wallet elated related with the subscription that should be returned as a result. The allowed wallet identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

Tip

Available from CRM.COM R10.0.0

type_identifier

(optional)

 Subscription type identifier

The identifier of the subscription type related with the subscriptions that will be retrieved. The allowed subscription type identifier fields are the following:

Include Page
V4:subscription_type_identifier
V4:subscription_type_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page
V4:subscription_complete
V4:subscription_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "life_cycle_state": "EFFECTIVE",
            "number": "S60143",
            "id": "A0A77A322991FCA28BB81CBE74E5F839"
        },
        {
            "life_cycle_state": "EFFECTIVE",
            "number": "S60144",
            "id": "3100943651B49A30CE90D5766B5CFD6C"
        }
    ]
}