Class: V2_MembershipAPI

new V2_MembershipAPI(rest)

This class is used to interact with Memberships in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/v2/Memberships.js, line 15

Methods

(async) getMembership(membership_id, optionsopt) → {Promise.<TidyAPI_V2_Membership>}

Get a single membership from TidyHQ.

Parameters:

Name Type Attributes Default Description

membership_id string The id of the membership to get.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/v2/Memberships.js, line 52

Returns:

- The membership.

Type:: Promise.<TidyAPI_V2_Membership>

(async) getMemberships(optionsopt) → {Promise.<TidyAPI_V2_Memberships>}

Get a list of memberships from TidyHQ.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`updated_before`	string	<optional>	ISO8601 formatted timestamp, only returns results last updated before the given time.
`updated_since`	string	<optional>	ISO8601 formatted timestamp, only returns results last updated since the given time.
`limit`	number	<optional>	The maximum number of memberships per page to return.
`offset`	number	<optional>	The number of memberships to skip.
`all`	boolean	<optional>	When given, returns all (including inactive) - defaults to only returning visible / active.
`active`	boolean	<optional>	When given, returns only users with active / inactive memberships (active is partial and activated status).

Source: src/v2/Memberships.js, line 38

Returns:

- An array of memberships.

Type:: Promise.<TidyAPI_V2_Memberships>

(async) getSubscriptions(optionsopt) → {Promise.<TidyAPI_V2_Subscriptions>}

Get a list of subscriptions from TidyHQ.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`updated_before`	string	<optional>	ISO8601 formatted timestamp, only returns results last updated before the given time.
`updated_since`	string	<optional>	ISO8601 formatted timestamp, only returns results last updated since the given time.
`limit`	number	<optional>	The maximum number of subscriptions per page to return.
`offset`	number	<optional>	The number of subscriptions to skip.
`active`	boolean	<optional>	When given, returns only users with active / inactive subscriptions (active is partial and activated status).

Source: src/v2/Memberships.js, line 69

Returns:

- An array of subscriptions.

Type:: Promise.<TidyAPI_V2_Subscriptions>

(async) renewSubscriptionForMembership(membership_id, subscription, optionsopt) → {Promise.<TidyAPI_V2_SubscriptionPost>}

Create/renew a subscription for a membership in TidyHQ.

Parameters:

Name Type Attributes Default Description

membership_id string The id of the membership to create a subscription for.

subscription Tidy_V2_PostSubscriptionParams The subscription parameters.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/v2/Memberships.js, line 84

Returns:

- The subscription, membership, payment url and invoice id.

Type:: Promise.<TidyAPI_V2_SubscriptionPost>