Skip to main content
POST
Turn auto-renew on or off

Request

Headers

Path parameters

Body parameters

How auto-renew works. The shopper opts in when buying a pass, by sending autoRenew: true when adding the line to the cart or when creating the order. If they pay by card through Paystack and the card can be charged again, it is saved (encrypted) on the access record. From then on, within 3 days before the pass ends, Salesive charges the saved card at today’s price and extends the pass by 30 days. After 3 failed charges auto-renew switches itself off, and the shopper is emailed each time.Turning it off here also throws the saved card away. Turning it on needs a card that was saved earlier, so there is no way to switch it on for a pass that was never bought with the opt-in. Lifetime access cannot be renewed.

Successful response

Error responses

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Path Parameters

entitlementId
string
required

The entitlementId of a library row.

Body

application/json
enabled
boolean
required

Response

Auto-renew updated.

status
integer
Example:

200

success
boolean
Example:

true

message
string
Example:

"Auto-renew turned off"

data
object
Example: