Skip to content

Change a member's renewal date

Request

This endpoint allows merchants to change the renewal (next billing) date of a customer's paid subscription. The customer must be an active member on a paid tier.

Note: the change is applied asynchronously. A successful response means the request was accepted — it may take a few moments before the new date is reflected on the subscription contract and the member record.

Security
api_key
Path
idstringrequired

The customer ID number.

Bodyapplication/jsonrequired
nextBillingDatestringrequired

The new renewal (next billing) date for the customer paid subscription. Must be a future date. Format: YYYY-MM-DD

curl -i -X POST \
  'https://public.inveterateapi.com/v2.0/admin/members/{id}/change-renewal-date' \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "nextBillingDate": "string"
  }'

Responses

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}