Zum Hauptinhalt springen
Manage plan subscriptions — lifecycle, claiming, listing, filtering, and admin operations. For general conventions, see JSON-API Conventions. For authentication, see Authentication.

Prerequisites

  • Admin API: Bearer token with admin access + ?o={organization_id}
  • Customer API: Authenticated customer account for claiming subscriptions

Public plan catalog (shop)

The shop subscription page loads plan groups from the public organization, then loads plans per group. Groups are morph-owned by the organization or its master. Empty groups and groups with only private plans are omitted.
Match the web shop: one section per offered group, then an Other section for filter[without_group]=true. Hide Other when that collection is empty.
Send filter[without_group]=true as a string. A JSON boolean query value is rejected by the JSON:API decoder.

Subscription Lifecycle

Key Date Fields

Status Lifecycle


Claiming a Subscription (Customer)

After a subscription is created (typically through an order), the customer claims it to activate:
Claiming transfers ownership from the customer record to the authenticated customer account. Subscriptions are initially attached to a customer (business record) and need to be linked to the customer account (login identity) for self-service management.

Admin Operations

Cancel

Sets cancels_at to the end of the current billing period. The subscription remains active until that date:

Revoke Cancellation

Un-cancels a subscription that hasn’t yet reached cancels_at:

Suspend

Pauses the subscription until a specified date:

Sell a Subscription

Staff of the organization that sells the plan can create a subscription with a custom price, seats and terms:
Without a custom term the plan’s minimum term and notice period apply. A plan with price 0 is free; a plan that charges nothing (no price, signup fee or seat fee) is sold without the organization’s online payments. Subscription exports are documented with the other admin export endpoints in Exports.

Listing Subscriptions

Subscriptions are identified by slug (not numeric ID).

Get Subscriptions for a Customer

For customer accounts (end-user access):
Automatically scoped to the authenticated customer account — no ?o= param needed.

Search by Customer

Filters

Sorting

Includes


Get a Single Subscription

Append ?include_summary=true to include a usage_summary in the response meta.

Response Schema

Attributes

Relationships

Example Response


Common Errors