README.md

Payouts

Overview

Available Operations

• list - List all payouts

list

Retrieve a list of payouts for your partner program.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.payouts.list();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DubCore } from "dub/core.js";
import { payoutsList } from "dub/funcs/payoutsList.js";

// Use `DubCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dub = new DubCore({
  token: "DUB_API_KEY",
});

async function run() {
  const res = await payoutsList(dub);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("payoutsList failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ListPayoutsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ListPayoutsResponseBody[]>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4XX, 5XX	*/*