---
title: "Get a CRA servicing subscription"
method: POST
path: "/cra/servicing/subscription/get"
tags: ["plaid"]
---

# Get a CRA servicing subscription

`POST /cra/servicing/subscription/get`

`/cra/servicing/subscription/get` returns the CRA servicing subscription identified by `subscription_id`.

## Request body

- CraServicingSubscriptionGetRequest — CraServicingSubscriptionGetRequest defines the request schema for `/cra/servicing/subscription/get`. Returns the subscription identified by `subscription_id`.
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `subscription_id` string, required — A CRA servicing subscription identifier, in the format `cra-sub-<environment>-<uuid>`.

## Response `200`

OK

- CraServicingSubscriptionGetResponse — CraServicingSubscriptionGetResponse defines the response schema for `/cra/servicing/subscription/get`.
  - `subscription` CraServicingSubscription, required — A single CRA servicing subscription.
    - `subscription_id` string, required — A CRA servicing subscription identifier, in the format `cra-sub-<environment>-<uuid>`.
    - `user_id` string, required — A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).
    - `scope` 'PLAID_NETWORK' | 'CLIENT_USER', required — Determines whose items are used. `PLAID_NETWORK` (default) uses the Plaid Network view of the user's profile. `CLIENT_USER` uses only the items linked by this client.
    - `cadence` 'DAILY' | 'null', nullable — The cadence at which products are generated and webhooks are fired. If the Qualify product is requested, cadence must be null or omitted, because Qualify's generation cadence is controlled by Plaid.
    - `webhook` string, nullable — The webhook URL Plaid sends report-update notifications to for this subscription, or null if none is set.
    - `products` CraSubscriptionProductConfig[], required — The products this subscription covers, each with the options it is configured with.
      - union — A product and its configuration, for use with CRA servicing subscription endpoints.
        - CraQualifyProductConfig — The Qualify product at a given version. Qualify accepts no additional configuration today.
          - `product` 'cra_qualify', required — The Qualify product discriminator.
          - `version` string, required — A string that specifies a particular version of a CRA product.
        - CraBaseReportProductConfig — The Base Report product at a given version. Base Report accepts no additional configuration today.
          - `product` 'cra_base_report', required — The Base Report product discriminator.
          - `version` string, required — A string that specifies a particular version of a CRA product.
        - CraIncomeInsightsProductConfig — The Income Insights product at a given version, together with options for additional configuration.
          - `product` 'cra_income_insights', required — The Income Insights product discriminator.
          - `version` string, required — A string that specifies a particular version of a CRA product.
          - `options` CraCheckReportCreateIncomeInsightsOptions, nullable — Defines configuration options to generate Income Insights.
            - `income_insights_filter` IncomeInsightsFilter, nullable — Filters the returned income streams based on the specified income categories. If no filters are requested, streams from the following default set of categories are returned: - `EARNED_INCOME.*` (`EARNED_INCOME.SALARY`, `EARNED_INCOME.GIG_ECONOMY`, `EARNED_INCOME.SELF_EMPLOYED`) - `BENEFITS.DISABILITY` - `RETIREMENT.*` (`RETIREMENT.GOVERNMENT_DERIVED`, `RETIREMENT.PRIVATE_RETIREMENT`, `RETIREMENT.PLAN_DISTRIBUTION`) The final list of income categories is generated by adding the `included_categories`, then removing the `excluded_categories`. Priority is given to `excluded_categories` in the case of collisions. Filter patterns supported: - `*`: All categories - `PRIMARY.*`: All categories within the specified primary category - `PRIMARY.SECONDARY`: A specific income category For a list of income categories, see the [Income V2 Category Taxonomy](https://plaid.com/documents/income-v2-category-taxonomy.csv).
              - …
            - `income_insights_version` 'II2', nullable, required — The version of Income Insights to use. This value is not shared across API calls for the same resource. If it is omitted from a request, the default version is used, even if a version was set in an earlier call such as `/link/token/create` or `/cra/check_report/create`.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

---

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