---
title: "Get list of subscriptions"
method: GET
path: "/v3/subscriptions"
tags: ["subscriptions"]
---

# Get list of subscriptions

`GET /v3/subscriptions`

## Request

- Base URL: `https://gateway.stage.bill.com/connect-events`
- URL: `https://gateway.stage.bill.com/connect-events/v3/subscriptions`
- Auth: none declared

Get a list of all your created subscriptions.

By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

**Note**: In this list operation, pagination is available only in one direction. The `nextPage` value is available in the response for you to retrieve the next page of results. However, you cannot retrieve the previous page of results.

See [Webhooks](doc:webhooks) in the Guides section for more information, sample requests, and notification payloads for BILL events.

## Query parameters

- `max` integer, nullable: Maximum number of results
- `page` string, nullable: Next page of results. When a list has multiple pages, the `nextPage` value in the response enables you to navigate to the next page of results. Set `page` as the `nextPage` value for navigation.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key sent to you by BILL when you create a developer account. Set `sessionId` and `devKey` for organization-level BILL v3 API webhook events.
- `appKey` string, nullable: Application key sent to you by BILL when you create a partner account. Set `sessionId` and `appKey` for partner-level BILL v3 API webhook events.
- `apiToken` string, nullable: Access token for Spend & Expense API authentication. Set `apiToken` for Spend & Expense webhook events.

## Response `200`

getAllSubscriptions 200 response

- ListSubscriptionResponseDto: Pagination information.
  - `nextPage` string
  - `results` SubscriptionResponseDto[]
    - `id` string: BILL-generated ID of the subscription
    - `name` string: Subscription name
    - `organizationId` string: BILL-generated ID of the organization. BILL sends you event notifications only for the BILL organization used to set up a subscription.
    - `status` object: Subscription status information
      - `enabled` boolean: Set as `true` if the subscription is enabled. When you create a new subscription, this value is set as `true` by default.
      - `reason` string: Reason for changing the subscription status. This field is used by BILL for informing you when the `enabled` field is set as `false`.
      - `actor` 'CLIENT' | 'SYSTEM': Entity that set the subscription status
    - `events` SubscriptionEventDto[]: Subscription events information. You can retrieve event `type` and `version` with `GET /v3/events/catalog`.
      - `type` string, required: Event type
      - `version` string, required: Event type version
    - `notificationUrl` string: Event notification URL. The URL must be HTTPS. BILL uses this URL to send you event notifications.
    - `createdTime` string, date-time: Subscription created date and time
    - `updatedTime` string, date-time: Subscription updated date and time

---

[API](https://skmtc.dev/bill/apis/connect-events-api.md) - [All operations](https://skmtc.dev/bill/apis/connect-events-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/connect-events-api/revisions/397b6f4013bc?raw)