0

Update Payout

by
Published Oct 30, 2023

Update a payout's metadata (the only editable field); keys are merged into the existing metadata.

Script stripe Verified

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 2 hours ago
1
//native
2

3
/**
4
 * Update Payout
5
 * Update a payout's metadata (the only editable field); keys are merged into the existing metadata.
6
 */
7
export async function main(
8
  auth: RT.Stripe,
9
  payout_id: string,
10
  metadata: { [key: string]: string }
11
) {
12
  const response = await fetch(
13
    `https://api.stripe.com/v1/payouts/${payout_id}`,
14
    {
15
      method: "POST",
16
      headers: {
17
        Authorization: `Bearer ${auth.token}`,
18
        "Content-Type": "application/x-www-form-urlencoded",
19
        Accept: "application/json",
20
        "Stripe-Version": "2025-03-31.basil",
21
      },
22
      body: toForm({ metadata }),
23
    }
24
  )
25

26
  if (!response.ok) {
27
    throw new Error(`${response.status} ${await response.text()}`)
28
  }
29

30
  return await response.json()
31
}
32

33
// Stripe takes form-encoded params with bracketed nesting: metadata[key]=v, items[0][price]=p
34
function toForm(
35
  params: { [key: string]: any },
36
  prefix = "",
37
  out = new URLSearchParams()
38
) {
39
  for (const [key, value] of Object.entries(params)) {
40
    if (value == null || value === "") continue
41
    const name = prefix ? `${prefix}[${key}]` : key
42
    if (typeof value === "object") toForm(value, name, out)
43
    else out.append(name, String(value))
44
  }
45
  return out
46
}
47

Other submissions
  • Submitted by hugo697 Typescript (fetch-only)
    Created 528 days ago
    1
    type Stripe = {
    2
      token: string;
    3
    };
    4
    /**
    5
     * Post payouts payout
    6
     * Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.
    7
     */
    8
    export async function main(
    9
      auth: Stripe,
    10
      payout: string,
    11
      body: { expand?: string[]; metadata?: { [k: string]: string } | "" }
    12
    ) {
    13
      const url = new URL(`https://api.stripe.com/v1/payouts/${payout}`);
    14
    
    
    15
      const response = await fetch(url, {
    16
        method: "POST",
    17
        headers: {
    18
          "Content-Type": "application/x-www-form-urlencoded",
    19
          Authorization: "Bearer " + auth.token,
    20
        },
    21
        body: encodeParams(body),
    22
      });
    23
      if (!response.ok) {
    24
        const text = await response.text();
    25
        throw new Error(`${response.status} ${text}`);
    26
      }
    27
      return await response.json();
    28
    }
    29
    
    
    30
    function encodeParams(o: any) {
    31
      function iter(o: any, path: string) {
    32
        if (Array.isArray(o)) {
    33
          o.forEach(function (a) {
    34
            iter(a, path + "[]");
    35
          });
    36
          return;
    37
        }
    38
        if (o !== null && typeof o === "object") {
    39
          Object.keys(o).forEach(function (k) {
    40
            iter(o[k], path + "[" + k + "]");
    41
          });
    42
          return;
    43
        }
    44
        data.push(path + "=" + o);
    45
      }
    46
      const data: string[] = [];
    47
      Object.keys(o).forEach(function (k) {
    48
        if (o[k] !== undefined) {
    49
          iter(o[k], k);
    50
        }
    51
      });
    52
      return new URLSearchParams(data.join("&"));
    53
    }
    54