Get Coupon Codes

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Get Coupon Codes

 * Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.

A coupon/coupons or a profile/profiles must be provided as required filter params.*Rate limits*:Burst: `350/s`Steady: `3500/m`

 */

export async function main(

  auth: Klaviyo,

  fields_coupon_code_: string | undefined,

  fields_coupon_: string | undefined,

  filter: string | undefined,

  include: string | undefined,

  page_cursor_: string | undefined,

  revision: string,

) {

  const url = new URL(`https://a.klaviyo.com/api/coupon-codes`);

  for (const [k, v] of [

    ["fields[coupon-code]", fields_coupon_code_],

    ["fields[coupon]", fields_coupon_],

    ["filter", filter],

    ["include", include],

    ["page[cursor]", page_cursor_],

  ]) {

    if (v !== undefined && v !== "" && k !== undefined) {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      revision: revision,

      "Accept": "application/vnd.api+json",

      Authorization: "Klaviyo-API-Key " + auth.apiKey,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}