MemorySync
API Reference · Control-plane API

Billing

Read the current organization plan with ControlPlaneClient.get_current_plan in Python or getCurrentPlan in Node.js.

Endpoint contract

GET/org/billing/current-plan
200 OK

Use the exact method and path shown above. Paths are relative to the API base URL.

Authentication, permission, and scope

ControlRequired contract
AuthenticationBearer access token.
Permission or scopeBilling access and billing:read scope.
Resource scopeThe result is resolved for the caller’s organization.

Request fields

FieldTypeContract
Request bodynoneThe current-plan request has no path, query, or body fields.

Code examples

import os
from memorysync import ControlPlaneClient


client = ControlPlaneClient(
    base_url="https://api.memorysync.io",
    access_token=os.environ["MEMORYSYNC_ACCESS_TOKEN"],
)


plan = client.get_current_plan()

Response shape

response.json
{"plan":{"id":"pro","name":"Pro","price_label":"$49/month","limits":{"add_requests":100000,"retrieval_requests":100000}},"status":"active","billing_period_start":"2026-08-01T00:00:00Z","billing_period_end":"2026-09-01T00:00:00Z","payment_failed":false,"scheduled_plan_id":null,"cancel_at_period_end":false}
  • Plan limits can be null when the plan treats a metric as unlimited.
  • Treat the returned billing period and plan status as current server state.

Status outcomes

HTTP outcomes
2xx
Request completed

Read the operation-specific response and persist only fields needed by the task.

400 / 422
Correct the request

Fix invalid path, query, or body fields before trying again.

401 / 403
Access denied

Refresh authentication or verify the required organization permission and scope.

404
Unavailable in scope

Treat the resource as unavailable without revealing whether it exists elsewhere.

429 / 5xx
Keep the action recoverable

Use returned retry metadata when present and reconcile uncertain mutations before repeating them.

Production handling

Production request path
  1. 01

    Authorize

    APP

    Confirm the signed-in principal may perform this product action.

  2. 02

    Validate

    INPUT

    Validate identifiers and body fields before sending the request.

  3. 03

    Call

    SDK

    Use the named ControlPlaneClient method or equivalent HTTPS request from a trusted application context.

  4. 04

    Inspect

    RESULT

    Render plan and payment state from the current response.

  5. 05

    Reconcile

    SAFE

    Refresh current-plan state after an authorized billing change rather than inferring an entitlement locally.

Security notes

Control-plane safety

Required

Keep organization controls inside trusted boundaries.

  • Authorize billing visibility in your application.
  • Do not log billing identifiers unnecessarily.
  • Do not infer mutation permission from a readable plan.

Avoid

Do not weaken the route contract in client code.

  • Do not expose bearer or refresh tokens in URLs, logs, or public clients.
  • Do not accept organization, member, project, or resource IDs without application authorization.
  • Do not treat returned data as trusted HTML, prompt instructions, or proof of application authorization.

Related reference

Plans

See customer-facing plan guidance.

Authentication

Compare bearer-authenticated control-plane clients with the memory API-key client.

API Overview

Choose the SDK client and authentication contract for the operation.

Was this page helpful?
← Previous
Memory Exports
Next →
Integrations