01.software Docs

cancelMembership

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/memberships/{id}/cancel

Owning customer JWT or tenant sk01_ write key; a customer JWT takes precedence. Omitted immediate cancels at period end. Only immediate=true revokes benefits now. Cancellation remains available after membership feature loss.

Authorization

headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

headerAuthorizationBearer <JWT>

Customer JWT for same-tenant authenticated customer actions

Path Parameters

id*string

Document ID

Request Body

Customer JWT lane accepts an absent/empty body as {}; sk01_ lane requires a JSON object.

application/json
  1. body
immediate?boolean

Response Body

Successful operation

application/json
  1. response
status*string
Value in"incomplete""trialing""active""past_due""cancelled""expired"

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/memberships/string/cancel' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "status": "incomplete"}