A SubscriptionVariant represents the subscriptions that are assigned to a group.
| Name | Description |
|---|---|
| getAction | Get whether the variant is to be assigned to or removed from the group. |
| getId | Get the system-generated identifier for the subscription variant. |
| getRequiresCredits | Get whether enrollments in the subscription require credits. |
| setAction | Set whether the variant is to be assigned to or removed from the group. |
| setId | Set the system-generated identifier for the subscription variant. |
| setRequiresCredits | Set whether enrollments in the subscription require credits. |
Description
public getAction (void)Get whether the variant is to be assigned to or removed from the group.
Parameters
This function has no parameters.
Return Values
?string
whether the variant is to be assigned or removed
Description
public getId (void)Get the system-generated identifier for the subscription variant.
Parameters
This function has no parameters.
Return Values
string
The system-generated identifier of the subscription
Description
public getRequiresCredits (void)Get whether enrollments in the subscription require credits.
Parameters
This function has no parameters.
Return Values
bool
True if and only if the subscription requires credits.
Description
public setAction (string $action)Set whether the variant is to be assigned to or removed from the group.
Parameters
(string) $action: 'Add' to add the variant to the
group, 'Remove' to remove it.
Return Values
self
Description
public setId (string $Id)Set the system-generated identifier for the subscription variant.
Parameters
(string) $Id: The system-generated identifier of the subscription
Return Values
self
Description
public setRequiresCredits (bool $requiresCredits)Set whether enrollments in the subscription require credits.
Parameters
(bool) $requiresCredits: True if and only if the subscription
requires credits.
Return Values
self