Member subscriptions

Read memberships in this resource

GET /api/v1/user/subscriptions

Read Pricing objects with this member’s membership dates and renewal flags added. This is not a public catalog listing or a list filtered to active/unexpired records: the query selects existing member relationships joined to their Pricing and Plan.

Before you call

Establish member identity, or its Firebase identity, in a valid resource. A relationship must exist to produce an item. Public Pricing availability alone is not membership.

Request

GET with no body or request Content-Type. Requires user role/inherited permission and active/unlocked member context. Supply sample configuration.

Pass limit explicitly: the paginator uses configured results_on_page (documented default: 10), while the omitted-limit response field uses the controller default 10; changed configuration can make those defaults differ.

The query is restricted to member ID and Plan resource, grouped by membership ID. Several membership records can therefore produce repeated Pricing IDs. The returned id is the Pricing ID, not the grouping membership ID. Filter errors do not have this action's explicit validity/error gate; do not assume the transaction-list error handling applies here.

Result

HTTP 200 JSON items[] plus paginator fields. Each item contains general Pricing, including its selected nested catalog fields, plus:

No timezone guarantee or content entitlement is implied. Empty items is an ordinary no-matching-record result.

curl "${WALLKIT_API_BASE}/api/v1/user/subscriptions?page=1&limit=10" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/subscriptions", process.env.WALLKIT_API_BASE);
  url.searchParams.set("page", "1");
  url.searchParams.set("limit", "10");
  const response = await fetch(url, { method: "GET", headers: {
    resource: process.env.RESOURCE_KEY, token: process.env.USER_TOKEN
  }});
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urlencode, urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/subscriptions") + "?" + urlencode({'page': '1', 'limit': '10'})
headers = {"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}
request = Request(url, headers=headers, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{"items":[{"id":2001,"plan_id":1001,"title":"Monthly","subscription_start_date":"2026-09-01 10:00:00","subscription_end_date":"2026-10-01 10:00:00","subscription_updated_date":"2026-09-01 10:00:00","autorenew":true,"is_trial":false,"is_team_subscription":false}]}

{"items":[]}

Change renewal on an existing relationship

POST /api/v1/user/subscriptions/{id}

Set the existing member/Pricing relationship's autorenew preference. This does not switch the member to another Pricing, perform an immediate charge, cancel access, refund a payment or delete the membership. The profile PUT and profile DELETE retain their distinct contracts.

Before you call

Requires active member context and user-role/inherited permission. The numeric path ID must identify an existing Pricing with a relationship for this member. Enabling renewal requires that Pricing's is_allowed_autorenew. The lookup checks member/Pricing IDs without a separate header-resource match; retain the intended member/resource/Pricing association in your integration.

The helper saves the renewal flag, invalidates membership caches and requests renewal events/conditional Campaign Monitor sync. It does not check the save boolean before the handler returns success. Read the returned state; HTTP 200 does not promise future successful renewal or event delivery. No membership deletion/payment-provider call is performed by this action itself.

Request

POST JSON object; null/omitted autorenew does not enter the update branch. Send a JSON boolean. The source's BooleanFilter treats false/empty and trimmed "false" as false, other truthy sanitized values as true; this is not strict JSON-boolean validation.

Result

HTTP 200 JSON top-level resource-aware user plus subscriptions and teams. Use the resource-aware user fields and profile user projections, matching the existing renewal profile projection. No subscriptions_history, assigned_tickets or last_action addition. Membership projection there does not expose the relationship ID used internally.

curl "${WALLKIT_API_BASE}/api/v1/user/subscriptions/2001" \
  -X POST \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"autorenew":false}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/subscriptions/2001", process.env.WALLKIT_API_BASE);
  const headers = {
    resource: process.env.RESOURCE_KEY,
    token: process.env.USER_TOKEN,
    "Content-Type": "application/json"
  };
  const response = await fetch(url, {
    method: "POST", headers, body: JSON.stringify({"autorenew":false})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/subscriptions/2001")
headers = {
    "resource": os.environ["RESOURCE_KEY"],
    "token": os.environ["USER_TOKEN"],
    "Content-Type": "application/json"
}
body = {'autorenew': False}
request = Request(url, data=json.dumps(body).encode("utf-8"), headers=headers, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{"id":7001,"subscriptions":[{"id":2001,"plan_id":1001,"autorenew":false}],"teams":[]}

{"error":"incorrect_subscription","error_description":"This subscription is not renewable","req_guid":"example-request","id":7001,"subscriptions":[{"id":2001,"plan_id":1001,"autorenew":false}],"teams":[]}