Skip to main content

Subscriptions

Overview

Manage recurring customer agreements and their lifecycle. Subscriptions represent ongoing access to services with defined terms, billing cycles, and pricing. Track statuses, filter records, view statistics, and perform bulk operations across customer subscriptions.

Primary Concepts

  • Subscription: an ongoing service agreement with defined terms and billing.
  • Status: current lifecycle state (active, expired, in_cancellation, cancelled).
  • Term: contract duration and renewal settings.
  • Billing Cycle: payment period and pricing calculations.
  • Items: individual products or services within a subscription.
  • Customer View: subscriptions grouped by customer or tenant.
  • Statistics: aggregated counts and pricing metrics by status.
  • Bulk Operations: batch actions like cancellation across multiple subscriptions.

Typical Scenarios

Retrieve subscription lists with filtering and pagination, view aggregated statistics for dashboards and reports, update subscription quantities, and cancel single or multiple subscriptions in batch operations.

API Versioning

  • Only the latest version of each endpoint is displayed in this documentation.
  • Older versions are not shown but remain available in the API.
  • Always use the latest version shown when building or updating integrations.