Start subscription grace period [Early Access]

Please note that this an Early Access phase. <br><br> Use this endpoint to notify Cleeng when an externally-managed subscription (EMS) enters a grace period (a temporary state where a payment attempt has failed, but the customer retains access while the external billing system retries the charge). <br><br> This call registers the grace period's start and its anticipated end date (gracePeriodEndDate) in the subscription history to ensure a reliable audit trail. Whenever you retrieve subscription data and a subscription is in grace period, gracePeriodEndDate is returned with date, otherwise it is null. <br><br> Note that this is a logging action; the endpoint does not alter the active subscription status itself, and the customer retains full access during this window.

post/subscriptions/{subscriptionId}/grace-period

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/subscriptions/{subscriptionId}/grace-period
  • Auth
    API key in header X-Publisher-Token

Path parameters

subscriptionIdinteger required

The identifier of the subscription entering a grace period.

Request body

gracePeriodEndDateinteger required

Expected end date of the grace period, as provided by the external billing system.

Format: Unix timestamp, seconds since epoch

Changes

No recorded changes to this operation across all 1 revision of this API.