Read a customer subscription

GEThttps://<your-url>/api/v2/customer-subscriptions/{customer_subscription}

MCP id customer-subscriptions.showAlso on this path: PATCH Update a customer subscription, DELETE Delete a customer subscription

View as Markdown openapi.json

Returns one subscription in the detail view.

Token scope: api:read:customer_subscriptions
Without it: 403 insufficient-token-scope.
Permission: customer_subscriptions::read
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One subscription with its customer

curl -G \
  'https://<your-url>/api/v2/customer-subscriptions/1' \
  --data-urlencode 'include=customer,subscription_type' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/customer-subscriptions/1?include=customer%2Csubscription_type', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/customer-subscriptions/1?include=customer%2Csubscription_type');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/customer-subscriptions/1?include=customer%2Csubscription_type',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "customer_id": 1,
    "customer": {
      "id": 1
    },
    "subscription_type_id": 1,
    "subscription_type": {
      "id": 1
    },
    "description": "Managed hosting and maintenance.",
    "status": "pending",
    "billing_interval": "yearly",
    "starts_at": "2026-07-01",
    "next_invoice_date": "2026-03-04",
    "cancelled_at": "2026-03-04",
    "expires_at": "2026-03-04"
  },
  "meta": {
    "actions": [
      "restore"
    ]
  }
}

8 more fields, listed under Response

Subscriptions are soft-deleted, so a deleted subscription is 404 unless trashed=with or trashed=only is passed; trashed=only 404s a live subscription. Its lines are not embedded: follow links.items, and its invoices are at sales-invoices?filter[customer_subscription_id]={id}.

Path parameters

customer_subscriptionintegerRequired

The CustomerSubscription's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a CustomerSubscription in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

customer_idinteger

Customer this subscription belongs to.

customerRef or CustomerSummary

The customer this subscription belongs to. Expanding it with ?include=customer additionally requires the customers::read permission and a token scope covering the customers prefix.

subscription_type_idinteger

Subscription type this subscription is an instance of.

subscription_typeRef or SubscriptionTypeSummary

The subscription type this subscription is an instance of, which is also where its displayed name comes from. Expanding it with ?include=subscription_type additionally requires the subscription_types::read permission and a token scope covering the subscription_types prefix.

descriptionstring or nullMultiline

What this subscription covers, as free text. This is the field ?q= searches, and it is also what a generated invoice line falls back to.

statusstring

Lifecycle status. Only an active subscription is picked up by the renewal run; the other three are inert.

pendingactivecancelledexpired

New values may be added.

billing_intervalstring

How often the subscription is invoiced. one-time forces auto_renew to false, because a one-off has no next period to move on to.

yearlymonthlyone-time

New values may be added.

starts_atdate (YYYY-MM-DD)

First day the subscription runs from, as a zone-free calendar date. Newest first is the default sort.

next_invoice_datedate (YYYY-MM-DD) or null

First day of the period to be invoiced next. Omit it on create and the server fills it with starts_at, so the first period is billable; the renewal run advances it by one interval each time it invoices. Null makes the subscription invisible to that run (it is skipped, silently), so a subscription that should never auto-invoice is expressed this way.

cancelled_atdate (YYYY-MM-DD) or null

Day the subscription was cancelled, null while it has not been. It is a record of the cancellation date only: nothing derives status from it.

expires_atdate (YYYY-MM-DD) or null

Day the subscription runs out, null when it is open-ended.

auto_renewboolean

Whether the renewal run may invoice this subscription again. A one-time subscription is always false: it is forced on every save, so sending true together with billing_interval=one-time succeeds and comes back as false rather than failing.

exact_subscription_idstring or null≤ 255Server-assigned

Exact Online subscription this one maps to, by Exact's own external identifier, not by a local id. Written by the sync; null when the subscription has never been synced.