api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

Headers0

BodyJSON

Examples

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Extend a User’s Subscription Bot Memberships

Move all eligible memberships belonging to the specified user within this project forward to a target date. This can affect memberships for multiple plans.

Only extend is accepted in the body. Sending membership_ids or all_memberships returns 422. To select a particular membership or a batch by ID, use selected membership extension.

Memberships that already end later, lifetime memberships, and expired memberships whose plan is full are skipped. More than 10,000 memberships for this user returns 409 without changes. This sets an end date, not an additional duration; sending the same date again does not extend twice.

Use the project membership list to inspect the resulting memberships.

PATCH/v2/projects/{project_id}/memberships/{user_id}/extend

Authorization

Bearer API KeyRequired

API key scope: memberships:update (required for restricted keys).

Path Parameters

project_idstringrequired

The unique identifier of the project.

user_idstringrequired

The user whose eligible memberships to extend across all plans in this project.

Request Body

extendstring | numberrequired

Future absolute expiry in UTC ISO format YYYY-MM-DDTHH:mm:ss.sssZ, for example 2030-01-01T00:00:00.000Z. Also accepts 13-digit Unix milliseconds for compatibility.

curl -X PATCH "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/memberships/123456789012345678/extend" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "extend": "2027-12-31T23:59:59.000Z"
  }'

const project_id = 'YOUR_PROJECT_ID';
const user_id = '123456789012345678';
 
const extend = '2027-12-31T23:59:59.000Z';
 
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/memberships/${user_id}/extend`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ extend })
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
user_id = '123456789012345678'
 
extend = '2027-12-31T23:59:59.000Z'
 
response = requests.patch(
    f'https://api.botsubscription.com/v2/projects/{project_id}/memberships/{user_id}/extend',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={'extend': extend}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$user_id = '123456789012345678';
 
$extend = '2027-12-31T23:59:59.000Z';
 
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/memberships/{$user_id}/extend");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'extend' => $extend
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

User memberships extendedapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "PATCH",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/123456789012345678/extend",
  "code": 200,
  "total": 1,
  "message": "Membership end dates set successfully",
  "data": {
    "new_end_date": "2027-12-31T23:59:59.000Z"
  }
}

Past timestampapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "PATCH",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/123456789012345678/extend",
  "code": 422,
  "error": {
    "error_code": "VALIDATION_ERROR",
    "message": "extend must be a future timestamp"
  }
}

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "PATCH",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/memberships/123456789012345678/extend",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026