Class

Subscriptions

Subscriptions(client) → {Subscriptions}

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

Constructor

# new Subscriptions(client) → {Subscriptions}

Creates an instance of the Subscriptions class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

An instance of the Subscriptions class.

Subscriptions

Methods

# async createBillingRequest(request) → {object}

Creates a new BillingRequest

Parameters:
Name Type Description
request object

The BillingRequest object.

The created BillingRequest object.

object

# async getBillingRequest(id) → {object}

Retrieve the BillingRequest object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the BillingRequest object.

The BillingRequest object.

object

# async getRecurringAsset(id) → {object}

Retrieve the RecurringAsset object identified by its id.

Parameters:
Name Type Description
id string

The unique identifier of the RecurringAsset object.

The RecurringAsset object.

object

# async searchBillingRequests(query) → {Array}

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

Parameters:
Name Type Description
query object

The optional query to filter results.

An array of BillingRequest object optionally matching the provided query.

Array

# async searchRecurringAssets(query) → {Array}

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

Parameters:
Name Type Description
query object

The optional query to filter results.

An array of RecurringAsset object optionally matching the provided query.

Array

# async updateBillingRequestAttributes(id, attributes) → {object}

Updates the attributes of a BillingRequest object.

Parameters:
Name Type Description
id string

The unique identifier of the BillingRequest object.
attributes object

An attributes object to be updated.

The updated BillingRequest attributes object.

object