provider 47 operations 15 docs pages
@utdk/figma
Figma API
Generated UTDK provider client for Figma API. This is the OpenAPI specification for the Figma REST API.
Note: we are releasing the OpenAPI specification as a beta given the large surface area and complexity of the REST API. If you notice any inaccuracies with the specification, please file an issue.
Payments
Optional generated docs page for
@utdk/figma.
Payments
Use these operations through the generated client (not direct HTTP calls).
Import path: @utdk/figma
Operations
figma.getPayments
- HTTP:
GET /v1/payments - What it does: Get payments
- OpenAPI operationId:
getPayments - Path params: None
- Query params:
plugin_payment_token,user_id,community_file_id,plugin_id,widget_id - Response codes:
200,401,429,500 - Transport options: None
- Source: OpenAPI reference
- TypeScript: Client interface
Inputs
- Client input type:
{ plugin_payment_token?: string; user_id?: string; community_file_id?: string; plugin_id?: string; widget_id?: string } - Client transport options: None
Outputs
- Client return type:
{ status: 200; error: false; meta: { user_id: string; resource_id: string; resource_type: "PLUGIN" | "WIDGET" | "COMMUNITY_FILE"; payment_status: { type?: "UNPAID" | "PAID" | "TRIAL" }; date_of_purchase?: string } } - OpenAPI response codes:
200,401,429,500
import figma from "@utdk/figma";
type GetPaymentsInput = Parameters<typeof figma.getPayments> extends [infer T, ...unknown[]] ? T : undefined;
type GetPaymentsOutput = Awaited<ReturnType<typeof figma.getPayments>>;
const input: GetPaymentsInput = {} as { plugin_payment_token?: string; user_id?: string; community_file_id?: string; plugin_id?: string; widget_id?: string };
const result: GetPaymentsOutput = await figma.getPayments(input);
// Result shape (from schema): { status: 200; error: false; meta: { user_id: string; resource_id: string; resource_type: "PLUGIN" | "WIDGET" | "COMMUNITY_FILE"; payment_status: { type?: "UNPAID" | "PAID" | "TRIAL" }; date_of_purchase?: string } }