---
title: "GET /api/subscription-transfers"
method: GET
path: "/api/subscription-transfers"
tags: ["api", "subscription-transfers"]
---

# GET /api/subscription-transfers

`GET /api/subscription-transfers`

## Request

- Base URL: `https://vivenu.com`
- URL: `https://vivenu.com/api/subscription-transfers`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Get all Subscription Transfers

## Query parameters

- `top` integer, required: A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` integer, required: The number of objects to skip for the requested result
- `subscriptionId` string: Filter by the ID of the origin subscription
- `status` string[]: Filter by status

## Response `200`

OK

- object
  - `docs` object[], required
    - `_id` string, required: The ID of the subscription transfer
    - `sellerId` string, required: The ID of the seller
    - `subscriptionId` string, required: The ID of the origin subscription
    - `subscriptionItemIds` string[], required: The IDs of the transferred subscription items
    - `status` 'CREATED' | 'TRANSFERRED' | 'REJECTED' | 'CANCELED' | 'EXPIRED', required: The status of the subscription transfer
    - `sender` object, required
      - `customerId` string, required: The ID of the sending customer
    - `recipient` object, required
      - `email` string, required: The email of the recipient
      - `customerId` string: The ID of the receiving customer
    - `outcome` object: The result of the transfer, set once it completes
      - `subscriptionId` string, required: The ID of the subscription created for the recipient
      - `items` object[], required
        - `originSubscriptionItemId` string, required: The ID of the item on the origin subscription
        - `subscriptionItemId` string, required: The ID of the item on the target subscription
    - `history` object[]
      - `type` 'created' | 'transferred' | 'rejected' | 'canceled' | 'expired', required
      - `date` string, date-time, required
      - `userId` string
    - `expiresAt` string, date-time, required: The date the transfer expires
    - `createdAt` string, date-time, required: The created timestamp
    - `updatedAt` string, date-time, required: The last updated timestamp
  - `total` number, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

## Changes

- **2026-11-12** `de433a1fa66d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vivenu/apis/vivenu-api/changes/api/subscription-transfers/get.md)

---

[API](https://skmtc.dev/vivenu/apis/vivenu-api.md) - [All operations](https://skmtc.dev/vivenu/apis/vivenu-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vivenu/apis/vivenu-api/revisions/488367c416c6?raw)