Get a list of coupons

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const couponListResponse of client.v1.coupons.list()) {
  console.log(couponListResponse.id);
}

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
page = client.v1.coupons.list()
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.V1.Coupons.List(context.TODO(), stigg.V1CouponListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.coupons.CouponListPage;
import io.stigg.models.v1.coupons.CouponListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        CouponListPage page = client.v1().coupons().list();
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Coupons;

StiggClient client = new();

CouponListParams parameters = new();

var page = await client.V1.Coupons.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "FIXED",
      "status": "ACTIVE",
      "source": "STIGG",
      "percentOff": 50,
      "amountsOff": [
        {
          "amount": 123,
          "currency": "usd"
        }
      ],
      "billingId": "<string>",
      "billingLinkUrl": "<string>",
      "durationInMonths": 2,
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prev": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

GET

api

coupons

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const couponListResponse of client.v1.coupons.list()) {
  console.log(couponListResponse.id);
}

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
page = client.v1.coupons.list()
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.V1.Coupons.List(context.TODO(), stigg.V1CouponListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.coupons.CouponListPage;
import io.stigg.models.v1.coupons.CouponListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        CouponListPage page = client.v1().coupons().list();
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Coupons;

StiggClient client = new();

CouponListParams parameters = new();

var page = await client.V1.Coupons.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "FIXED",
      "status": "ACTIVE",
      "source": "STIGG",
      "percentOff": 50,
      "amountsOff": [
        {
          "amount": 123,
          "currency": "usd"
        }
      ],
      "billingId": "<string>",
      "billingLinkUrl": "<string>",
      "durationInMonths": 2,
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prev": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

Authorizations

X-API-KEY

string

header

required

Server API Key

Headers

X-ACCOUNT-ID

string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID

string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Query Parameters

after

string<uuid>

Return items that come after this cursor

before

string<uuid>

Return items that come before this cursor

limit

integer

default:20

Maximum number of items to return

Required range: 1 <= x <= 100

string

Filter by entity ID

Maximum string length: 255

status

enum<string>[]

Filter by coupon status. Supports comma-separated values for multiple statuses

Available options:

ACTIVE,

ARCHIVED

type

enum<string>

Filter by coupon type (FIXED or PERCENTAGE)

Available options:

FIXED,

PERCENTAGE

createdAt

object

Filter by creation date using range operators: gt, gte, lt, lte

Show child attributes

Response

A paginated list of coupon objects.

Response list object

data

Coupon · object[]

required

Show child attributes

pagination

object

required

Pagination metadata including cursors for navigating through results

Show child attributes

Get started

Essentials

Subscriptions

Bulk Import

Usage

Coupons

Products

Features

Addons

Plans

Promotional Entitlements

Customers

Customer Integrations

Data Export

Entitlements

Plan Entitlements

Addon Entitlements

Credit grants

Credit consumption

Credit usage

Auto recharge

Custom currencies

Credit ledger

Contracts

Invoices

Governance Entity Types

Governance Entities

Governance Assignments

Governance Hierarchy

Governance Entitlements Check

Get a list of coupons

Authorizations

Headers

Query Parameters

Response