Close
Community
PDF

Subscriptions

The Subscriptions class exposes specialized methods to help
developers to handle subscriptions (recurring assets and billing requests.).

Kind: global class
Category: Operations

new Subscriptions(client)

Creates an instance of the Subscriptions class.

Returns: Subscriptions – An instance of the Subscriptions class.

Param Type Description
client ConnectClient An instance of the ConnectClient class.

subscriptions.searchBillingRequests(query) ⇒ Array

Returns a list of BillingRequest objects that match the provided
(optional) query.

Kind: instance method of Subscriptions
Returns: Array – An array of BillingRequest object optionally matching
the provided query.

Param Type Description
query object The optional query to filter results.

subscriptions.createBillingRequest(request) ⇒ object

Creates a new BillingRequest

Kind: instance method of Subscriptions
Returns: object – The created BillingRequest object.

Param Type Description
request object The BillingRequest object.

subscriptions.getBillingRequest(id) ⇒ object

Retrieve the BillingRequest object identified by its id.

Kind: instance method of Subscriptions
Returns: object – The BillingRequest object.

Param Type Description
id string The unique identifier of the BillingRequest object.

subscriptions.updateBillingRequestAttributes(id, attributes) ⇒ object

Updates the attributes of a BillingRequest object.

Kind: instance method of Subscriptions
Returns: object – The updated BillingRequest attributes object.

Param Type Description
id string The unique identifier of the BillingRequest object.
attributes object An attributes object to be updated.

subscriptions.searchRecurringAssets(query) ⇒ Array

Returns a list of RecurringAsset objects that match the provided
(optional) query.

Kind: instance method of Subscriptions
Returns: Array – An array of RecurringAsset object optionally matching
the provided query.

Param Type Description
query object The optional query to filter results.

subscriptions.getRecurringAsset(id) ⇒ object

Retrieve the RecurringAsset object identified by its id.

Kind: instance method of Subscriptions
Returns: object – The RecurringAsset object.

Param Type Description
id string The unique identifier of the RecurringAsset object.
Is this page helpful?
Translate with Google
Contents
    Translate with Google
    Is this page helpful?
    Copied to clipboard