---
title: "Get payments"
method: GET
path: "/v1/payments"
tags: ["Payments"]
---

# Get payments

`GET /v1/payments`

There are two methods to query for a user's payment information on a plugin, widget, or Community file. The first method, using plugin payment tokens, is typically used when making queries from a plugin's or widget's code. The second method, providing a user ID and resource ID, is typically used when making queries from anywhere else.

Note that you can only query for resources that you own. In most cases, this means that you can only query resources that you originally created.

## Query parameters

- `plugin_payment_token` string
- `user_id` number
- `community_file_id` number
- `plugin_id` number
- `widget_id` number

## Response `200`

Response from the GET /v1/payments endpoint.

- object
  - `status` 200, required — The response status code.
  - `error` false, required — For successful requests, this value is always `false`.
  - `meta` PaymentInformation, required — An object describing a user's payment information for a plugin, widget, or Community file.
    - `user_id` string, required — The ID of the user whose payment information was queried. Can be used to verify the validity of a response.
    - `resource_id` string, required — The ID of the plugin, widget, or Community file that was queried. Can be used to verify the validity of a response.
    - `resource_type` 'PLUGIN' | 'WIDGET' | 'COMMUNITY_FILE', required — The type of the resource.
    - `payment_status` PaymentStatus, required — An object describing the user's payment status.
      - `type` 'UNPAID' | 'PAID' | 'TRIAL' — The current payment status of the user on the resource, as a string enum: - `UNPAID`: user has not paid for the resource - `PAID`: user has an active purchase on the resource - `TRIAL`: user is in the trial period for a subscription resource
    - `date_of_purchase` string, date-time — The UTC ISO 8601 timestamp indicating when the user purchased the resource. No value is given if the user has never purchased the resource. Note that a value will still be returned if the user had purchased the resource, but no longer has active access to it (e.g. purchase refunded, subscription ended).

## Other responses

- `401` — Token is missing or incorrect.
- `429` — In some cases API requests may be throttled or rate limited. Please wait a while before attempting the request again (typically a minute).
- `500` — An internal server error occurred.

---

[API](https://skmtc.dev/thirdstrandstudio/apis/figma-api.md) · [All operations](https://skmtc.dev/thirdstrandstudio/apis/figma-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/thirdstrandstudio/figma-api/revisions/48f84f49653a/schema)