# List related Subscriptions

`GET /v2/subscriptions/{id}/related`

Core API v2, Subscriptions.

Returns the other Subscriptions of the same Customer that were bought together with this one: those sharing its setup payment, plus — when the merchant has configured a grouping window — those created within that many minutes of it. Read-only; nothing is cancelled or changed.

**Authentication:** Send `Authorization: Bearer <token>`. To authenticate, generate a Secret API Key from your ODUS Dashboard and include it in the `Authorization` header as follows: `Authorization: Bearer <YOUR_SECRET_API_KEY>`

## Parameters

### Path parameters

- `id` (string, required)

## Responses

### `200`

OK

Type: object (RelatedSubscriptionsDTO).

- `windowMinutes` (number, required): The merchant's configured grouping window, in minutes, that this lookup applied. `0` means only the setup payment was used. Example: `0`.
- `subscriptions` (array of object, required): The other subscriptions of the same customer that belong to the same purchase, oldest first.
  - `id` (string, required): The ID of the related subscription. Example: `sub_2QC7PqoUeOxQEWscJJt6B3PkvyL`.
  - `status` (string, required): The status of the related subscription. One of `active`, `cancelled`. Example: `active`.
  - `cancelAtPeriodEnd` (boolean, required): Whether the related subscription is cancelled when its current billing cycle ends. Example: `false`.
  - `cancelAtCycle` (number, required, nullable): The cycle at whose end the related subscription is scheduled to be cancelled, or `null` when no cancellation is scheduled. Example: `2`.
  - `createdAt` (string (date-time), required): When the related subscription was created.
  - `createdAtDeltaSeconds` (number, required): Seconds between the creation of the subscription being viewed and this one. Negative when this one was created first. Example: `42`.
  - `amount` (number, required): Amount charged each billing cycle, in cents. `0` marks a free subscription — the case this grouping exists to surface. Example: `0`.
  - `currency` (string, required): The currency of the recurring amount. One of `usd`, `eur`, `gbp`, `cad`, `aud`, `pln`, `czk`, `sek`, `dkk`. Example: `usd`.
  - `priceName` (string, required): The name of the price the related subscription bills on. Example: `Monthly membership`.
  - `productName` (string, required): The name of the product behind that price. Example: `Membership`.
  - `matchedOn` (string, required): Why this subscription is part of the group: it shares the viewed subscription’s setup payment, or it was created within the merchant’s configured window. One of `setup_payment`, `creation_window`. Example: `setup_payment`.

### `202`

The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.

Type: object (ProvisioningInProgress).

- `status` (string, required): Signals the merchant environment is still being provisioned. One of `provisioning`.
- `merchantAccountId` (string, required): The merchant account whose environment is being provisioned. Example: `dAI3aa87ROOeupeBCjNSKCOBOisBCYjB`.

### Errors

- `400`: The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; or `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it.
- `401`: No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403`: The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `404`: No resource exists with the requested identifier. `type` is `not_found_error`.
- `429`: Too many requests. A limit applies per operation; requests to other operations are unaffected. `type` is `rate_limit_error`. Use the `Retry-After-global` header to know when to retry.
- `500`: The request could not be completed because of an unexpected error. `type` is `api_error`.
- `503`: The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. `type` is `api_error`. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff.
- `504`: The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

Every error response has the same body: see [Errors](https://docs.odus.com/docs/guides/api-features/errors.md).

---

Generated from the Core API v2 OpenAPI document, https://api.odus.com/openapi.v2.json. Interactive page: https://docs.odus.com/docs/api/core/v2/subscription-controller-find-related