Lấy Giảm Giá theo Mã

GET

discounts

code

{code}

JavaScript

import DodoPayments from 'dodopayments';

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

const discount = await client.discounts.retrieveByCode('code');

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
)
discount = client.discounts.retrieve_by_code(
    "code",
)
print(discount.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"),
	)
	discount, err := client.Discounts.GetByCode(context.TODO(), "code")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", discount.BusinessID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.discounts.Discount;
import com.dodopayments.api.models.discounts.DiscountRetrieveByCodeParams;

public final class Main {
    private Main() {}

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

        Discount discount = client.discounts().retrieveByCode("code");
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.discounts.Discount
import com.dodopayments.api.models.discounts.DiscountRetrieveByCodeParams

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

    val discount: Discount = client.discounts().retrieveByCode("code")
}

require "dodopayments"

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

discount = dodo_payments.discounts.retrieve_by_code("code")

puts(discount)

<?php

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

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

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

try {
  $discount = $client->discounts->retrieveByCode('code');

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

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

DodoPaymentsClient client = new();

DiscountRetrieveByCodeParams parameters = new() { Code = "code" };

var discount = await client.Discounts.RetrieveByCode(parameters);

Console.WriteLine(discount);

use dodopayments::Client;

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

{
  "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
}

Ủy quyền

Authorization

string

header

bắt buộc

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

Tham số đường dẫn

code

string

bắt buộc

The discount code (e.g., 'SAVE20')

Phản hồi

Fetched discount by code

amount

integer<int32>

bắt buộc

The discount amount in basis points (e.g., 540 => 5.4%).

business_id

string

bắt buộc

The business this discount belongs to.

code

string

bắt buộc

The discount code (up to 16 chars).

created_at

string<date-time>

bắt buộc

Timestamp when the discount is created

customer_eligibility

enum<string>

bắt buộc

Who may redeem this discount code.

Tùy chọn có sẵn:

any,

first_time,

existing,

specific

discount_id

string

bắt buộc

The unique discount ID

metadata

Metadata · object

bắt buộc

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Show child attributes

preserve_on_plan_change

boolean

bắt buộc

Whether this discount should be preserved when a subscription changes plans. Default: false (discount is removed on plan change)

restricted_to

string[]

bắt buộc

List of product IDs to which this discount is restricted.

times_used

integer<int32>

bắt buộc

How many times this discount has been used.

type

enum<string>

bắt buộc

The type of discount (percentage or flat).

Tùy chọn có sẵn:

flat,

percentage

currency_options

object[]

Per-currency options (flat deduction / percentage cap + minimum subtotal). Empty for discounts without any configured currency options.

Show child attributes

expires_at

string<date-time> | null

Optional date/time after which discount is expired.

name

string | null

Name for the Discount

per_customer_usage_limit

integer<int32> | null

Maximum number of times a single customer may redeem this discount, if any.

starts_at

string<date-time> | null

Optional date/time before which the discount is not yet active. NULL = active immediately.

subscription_cycles

integer<int32> | null

Number of subscription billing cycles this discount is valid for. If not provided, the discount will be applied indefinitely to all recurring payments related to the subscription.

usage_limit

integer<int32> | null

Usage limit for this discount, if any.

Lần sửa đổi cuối 1 tháng 4, 2026

Cập nhật Giảm giáCập nhật một giảm giá trong tài khoản của bạn.

JavaScript

import DodoPayments from 'dodopayments';

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

const discount = await client.discounts.retrieveByCode('code');

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
)
discount = client.discounts.retrieve_by_code(
    "code",
)
print(discount.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"),
	)
	discount, err := client.Discounts.GetByCode(context.TODO(), "code")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", discount.BusinessID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.discounts.Discount;
import com.dodopayments.api.models.discounts.DiscountRetrieveByCodeParams;

public final class Main {
    private Main() {}

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

        Discount discount = client.discounts().retrieveByCode("code");
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.discounts.Discount
import com.dodopayments.api.models.discounts.DiscountRetrieveByCodeParams

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

    val discount: Discount = client.discounts().retrieveByCode("code")
}

require "dodopayments"

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

discount = dodo_payments.discounts.retrieve_by_code("code")

puts(discount)

<?php

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

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

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

try {
  $discount = $client->discounts->retrieveByCode('code');

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

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

DodoPaymentsClient client = new();

DiscountRetrieveByCodeParams parameters = new() { Code = "code" };

var discount = await client.Discounts.RetrieveByCode(parameters);

Console.WriteLine(discount);

use dodopayments::Client;

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

{
  "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

Ủy quyền

Tham số đường dẫn

Phản hồi