Recurring subscription billing errors

A member with a recurring subscription will be automatically billed at regular intervals. When a billing error occurs, the member may need to take action.

Check for billing errors

Use the GetCurrentMember endpoint to load the authenticated member's subscriptions. If the billingError property is not equal to null, an error has occurred during the most recent billing attempt.

{
  "member": {
    "id": "string",
    "hash": "string",
    "subscriptions": {
      "current": {
        "subscriptionId": 0,
        "status": "Active",
        "startsAt": "2019-08-24T14:15:22Z",
        "expiresAt": "2019-08-24T14:15:22Z",
        "billingDetails": {
          "isRecurring": true,
          "reactivationPrice": {
            "valueIncludingTax": 0.1,
            "valueExcludingTax": 0.1,
            "tax": 0.1
          },
          "isUsingThirdPartyPaymentProvider": true,
          "currentBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
          "nextBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
          "billingError": {
            "willBeRetried": true
          }
        }
      },
      "future": null
    }
  }
}

Automatic billing attempts

When a billing error occurs, it may be automatically reattempted up to the configured maximum billing attempts.

Load the member's subscriptions and check the willBeRetried property of the billingError to determine whether billing will be automatically reattempted.

Reactivating a frozen subscription

When the maximum automatic billing attempts have been reached, the member's subscription will immediately become frozen.

When a subscription has become frozen, the member must manually reactivate their subscription to re-enable their subscription benefits.

Cancellation

After the minimum contracted term has ended, a member may choose to cancel their subscription at any time, including after a billing error has occurred.

If a member cancels their subscription during a billing error, the subscription will immediately end.