You are here

public function BillingSchedule::getUnpaidSubscriptionState in Commerce Recurring Framework 8

Gets the unpaid subscription state.

This is the state that the subscription will transition to after the end of the dunning cycle. Common values:

  • active (indicating that the subscription should stay active)
  • canceled (indicating that the subscription should be canceled).

Return value

string The subscription state.

Overrides BillingScheduleInterface::getUnpaidSubscriptionState

File

src/Entity/BillingSchedule.php, line 203

Class

BillingSchedule
Defines the billing schedule entity class.

Namespace

Drupal\commerce_recurring\Entity

Code

public function getUnpaidSubscriptionState() {
  return $this->unpaidSubscriptionState;
}