Rate this page:

ChildAccounts

Methods

AddChildAccountSubscription

Copy URL

Adds a new subscription for the specified child account.

AddChildAccountSubscription example

AddChildAccountSubscription example

Create a subscription for the child account with ID = 10 using the subscription template with ID = 184.

Parameters

  • child_account_id:

    number

    Optional

    The child account ID.

  • subscription_template_id:

    number

    Optional

    The subscription template ID.

  • subscription_name:

    string

    Optional

    The subscription name.

Returns

GetChildAccountSubscriptions

Copy URL

Gets the active subscription(s) for the specified child account.

GetChildAccountSubscriptions example

GetChildAccountSubscriptions example

Get the subscription with ID = 20.

Parameters

  • child_account_id:

    number

    Optional

    The child account ID.

  • subscription_id:

    number

    Optional

    The subscription ID. If empty, then all the non-deactivated subscriptions for the current child account will be retrieved.

GetChildAccountSubscriptionTemplates

Copy URL

Gets all the eligible subscription templates. A template is considered to be eligible if it is of a type that supports child accounts management.

GetChildAccountSubscriptionTemplates example

GetChildAccountSubscriptionTemplates example

Get the eligible subscription templates.

DeactivateChildAccountSubscription

Copy URL

Deactivates the specified subscription(s).

DeactivateChildAccountSubscription example

DeactivateChildAccountSubscription example

Deactivates the subscription with ID = 20 and subscription_finish_date = September 29th 2019.

Parameters

  • subscription_id:

    number

    Optional

    The subscription ID to be deactivated.

  • child_account_id:

    number

    Optional

    The child account ID.

  • subscription_finish_date:

    timestamp

    Optional

    The deactivation UTC date in 24-h format: YYYY-MM-DD HH:mm:ss. If empty, then the current date + 1 day is used as a cancellation date.

Returns

  • result:

    number

    1