---
title: "GET /api/v1/Subscriptions"
method: GET
path: "/api/v1/Subscriptions"
tags: ["Subscriptions"]
---

# GET /api/v1/Subscriptions

`GET /api/v1/Subscriptions`

## Query parameters

- `OrganizationId` integer
- `CustomerTenantId` integer
- `PublisherId` integer
- `Refresh` boolean
- `Statuses` 0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 446 | 511
- `IsTrial` boolean, nullable
- `Page` integer
- `PageSize` integer
- `Search` string, nullable
- `RegisteredForReservedInstance` boolean, nullable
- `PublisherCustomerId` string, nullable
- `SortBy` 0 | 1 | 2 | 3
- `SortOrder` 0 | 1

## Response `200`

Success

- SubscriptionExtended[]
  - `invoiceProfile` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `id` integer
  - `publisherSubscriptionId` string, nullable
  - `entitlementId` string, nullable
  - `publisher` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `organization` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `customerTenant` CustomerTenantReference
    - `id` integer
  - `product` ProductReference
    - `id` integer
    - `partNumber` string, nullable
    - `publisherProductId` string, nullable
    - `itemLegalName` string, nullable
    - `itemName` string, nullable
  - `quantity` integer
  - `name` string, nullable
  - `status` 0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 446 | 511
  - `provisionType` 0 | 1 | 2 | 3 | 4 | 5
  - `availableAddonsCount` integer
  - `subscriptions` SubscriptionAddOn[], nullable
    - `id` integer
    - `publisherSubscriptionId` string, nullable
    - `publisherCustomerId` string, nullable
    - `name` string, nullable
    - `status` 0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 446 | 511
    - `quantity` integer
    - `organization` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `orderId` string, nullable
    - `creationDate` string, date-time
    - `product` ProductReference
      - `id` integer
      - `partNumber` string, nullable
      - `publisherProductId` string, nullable
      - `itemLegalName` string, nullable
      - `itemName` string, nullable
    - `publisher` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `markup` number, double
    - `subscriptionTags` SubscriptionTags
      - `subscriptionId` integer
      - `costCenter` string, nullable
      - `department` string, nullable
      - `project` string, nullable
      - `custom` string, nullable
      - `owner` string, nullable
      - `createdDate` string, date-time
      - `modifiedDate` string, date-time
    - `termDuration` string, nullable
    - `autoRenewEnabled` boolean, nullable
    - `cancellationAllowedUntilDate` string, date-time, nullable
  - `orderId` string, nullable
  - `creationDate` string, date-time
  - `billingCycle` 0 | 1 | 2 | 3 | 4 | 5 | 7 | 8 | 9
  - `markup` number, double
  - `isTrial` boolean
  - `startDate` string, date-time, nullable
  - `endDate` string, date-time, nullable
  - `priceType` 1 | 2 | 3
  - `salesPrice` number, double
  - `registeredForReservedInstance` boolean
  - `subscriptionTags` SubscriptionTags
    - `subscriptionId` integer
    - `costCenter` string, nullable
    - `department` string, nullable
    - `project` string, nullable
    - `custom` string, nullable
    - `owner` string, nullable
    - `createdDate` string, date-time
    - `modifiedDate` string, date-time
  - `acceptAutoSuspension` boolean, nullable
  - `autoSuspensionDate` string, date-time, nullable
  - `partNumber` string, nullable
  - `termDuration` string, nullable
  - `autoRenewEnabled` boolean, nullable
  - `cancellationAllowedUntilDate` string, date-time, nullable
  - `scheduledNextTermInstructions` ScheduledNextTermInstructions
    - `product` Product
      - `productId` string, nullable
      - `skuId` string, nullable
      - `availabilityId` string, nullable
      - `billingCycle` string, nullable
      - `termDuration` string, nullable
    - `quantity` integer
    - `customTermEndDate` string, date-time, nullable
  - `maxEndCustomerQuantity` integer, nullable
  - `renewalType` 0 | 1 | 2
  - `renewalEffectiveDate` string, date-time, nullable

---

[API](https://skmtc.net/crayon/apis/crayon-group-customer-api.md) · [All operations](https://skmtc.net/crayon/apis/crayon-group-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crayon/crayon-group-customer-api/revisions/a04494a78f65/schema)