Renew

Subscription Renewal endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Renewals should be initiated within a 14-day timeframe that spans both before and after the current subscription period's end date. This restriction is only enforced on production - on staging, renewals can be created at any point. The start of the new period will align with the conclusion of the current one.

  • When you attempt to renew a subscription before the designated renewal period, the request will be unsuccessful, resulting in a "400 - Not in Time Window" error.
  • If you try to renew a subscription after the renewal window has passed, the renewal request will fail accompanied by a "400 - Not Active" error. From Mulberry's perspective, the renewal failed and the subscription has been cancelled.

Mulberry does not send email communication on renew success or failure.

For more information on Authentication, please see the authentication docs.

Path Params
string
required

Your internal identifier for tracking the subscription.

Body Params
boolean
required

Set to False if the subscription renewal failed on your side.

string

Free text to explain why the renewal failed.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json