Listar Descuentos

GET

discounts

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const discount of client.discounts.list()) {
  console.log(discount.business_id);
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.discounts.list()
page = page.items[0]
print(page.business_id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	page, err := client.Discounts.List(context.TODO(), dodopayments.DiscountListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.discounts.DiscountListPage;
import com.dodopayments.api.models.discounts.DiscountListParams;

public final class Main {
    private Main() {}

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

        DiscountListPage page = client.discounts().list();
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.discounts.DiscountListPage
import com.dodopayments.api.models.discounts.DiscountListParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val page: DiscountListPage = client.discounts().list()
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

page = dodo_payments.discounts.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Discounts\DiscountType;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $page = $client->discounts->list(
    active: true,
    code: 'code',
    discountType: DiscountType::FLAT,
    pageNumber: 0,
    pageSize: 0,
    productID: 'product_id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Discounts;

DodoPaymentsClient client = new();

DiscountListParams parameters = new();

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

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .discounts()
        .list()
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "discount_id": "<string>",
      "metadata": {},
      "preserve_on_plan_change": true,
      "restricted_to": [
        "<string>"
      ],
      "times_used": 123,
      "currency_options": [
        {
          "is_default": true,
          "minimum_subtotal": 123,
          "max_amount_possible": 123
        }
      ],
      "expires_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "per_customer_usage_limit": 123,
      "starts_at": "2023-11-07T05:31:56Z",
      "subscription_cycles": 123,
      "usage_limit": 123
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

page_size

integer<int32>

Page size (default = 10, max = 100).

Rango requerido: x >= 0

page_number

integer<int32>

Page number (default = 0).

Rango requerido: x >= 0

code

string

Filter by discount code (partial match, case-insensitive)

discount_type

enum<string>

Filter by discount type

Opciones disponibles:

flat,

percentage

active

boolean

Filter by active status. true = currently redeemable (started, not expired, not usage-exhausted). false = not currently redeemable (expired, usage-exhausted, or pending a future starts_at).

product_id

string

Filter by product restriction (only discounts that apply to this product)

Respuesta

List of active Discounts

items

object[]

requerido

Array of active (non-deleted) discounts for the current page.

Show child attributes

Última modificación el 1 de abril de 2026

Crear DescuentoCrea un descuento para tu cuenta.

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const discount of client.discounts.list()) {
  console.log(discount.business_id);
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.discounts.list()
page = page.items[0]
print(page.business_id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	page, err := client.Discounts.List(context.TODO(), dodopayments.DiscountListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.discounts.DiscountListPage;
import com.dodopayments.api.models.discounts.DiscountListParams;

public final class Main {
    private Main() {}

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

        DiscountListPage page = client.discounts().list();
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.discounts.DiscountListPage
import com.dodopayments.api.models.discounts.DiscountListParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val page: DiscountListPage = client.discounts().list()
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

page = dodo_payments.discounts.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Discounts\DiscountType;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $page = $client->discounts->list(
    active: true,
    code: 'code',
    discountType: DiscountType::FLAT,
    pageNumber: 0,
    pageSize: 0,
    productID: 'product_id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Discounts;

DodoPaymentsClient client = new();

DiscountListParams parameters = new();

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

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .discounts()
        .list()
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "discount_id": "<string>",
      "metadata": {},
      "preserve_on_plan_change": true,
      "restricted_to": [
        "<string>"
      ],
      "times_used": 123,
      "currency_options": [
        {
          "is_default": true,
          "minimum_subtotal": 123,
          "max_amount_possible": 123
        }
      ],
      "expires_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "per_customer_usage_limit": 123,
      "starts_at": "2023-11-07T05:31:56Z",
      "subscription_cycles": 123,
      "usage_limit": 123
    }
  ]
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Entitlements

Customers

Customer Wallets

Products

Localized Pricing

Addons

Credit Entitlements

Meters

Usage Events

Refunds

Disputes

Payouts

Balance Ledger

Brands

Webhooks

Miscellaneous

Product Collections

Autorizaciones

Parámetros de consulta

Respuesta