Class Subscriptions

Updated: March 5, 2020
Contents

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.

ParamTypeDescription
clientConnectClientAn 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.

ParamTypeDescription
queryobjectThe optional query to filter results.

subscriptions.createBillingRequest(request) ⇒ object

Creates a new BillingRequest

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

ParamTypeDescription
requestobjectThe BillingRequest object.

subscriptions.getBillingRequest(id) ⇒ object

Retrieve the BillingRequest object identified by its id.

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

ParamTypeDescription
idstringThe 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.

ParamTypeDescription
idstringThe unique identifier of the BillingRequest object.
attributesobjectAn 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.

ParamTypeDescription
queryobjectThe 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.

ParamTypeDescription
idstringThe unique identifier of the RecurringAsset object.
Is this page helpful?
Translate with Google
Copied to clipboard