更新折扣

更新您账户中的折扣。

PATCH /discounts/{discount_id}

JavaScript

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.update('dsc_qxxEmg5PuM1uNTE0LgkP9');

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.update(
    discount_id="dsc_qxxEmg5PuM1uNTE0LgkP9",
)
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.Update(
		context.TODO(),
		"dsc_qxxEmg5PuM1uNTE0LgkP9",
		dodopayments.DiscountUpdateParams{},
	)
	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.DiscountUpdateParams;

public final class Main {
    private Main() {}

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

        Discount discount = client.discounts().update("dsc_qxxEmg5PuM1uNTE0LgkP9");
    }
}

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.DiscountUpdateParams

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

    val discount: Discount = client.discounts().update("dsc_qxxEmg5PuM1uNTE0LgkP9")
}

require "dodopayments"

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

discount = dodo_payments.discounts.update("dsc_qxxEmg5PuM1uNTE0LgkP9")

puts(discount)

<?php

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

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

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

try {
  $discount = $client->discounts->update(
    'dsc_qxxEmg5PuM1uNTE0LgkP9',
    amount: 0,
    code: 'code',
    currencyOptions: [
      [
        'currency' => Currency::AED,
        'isDefault' => true,
        'maxAmountPossible' => 0,
        'minimumSubtotal' => 0,
      ],
    ],
    customerEligibility: 'any',
    expiresAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    metadata: ['foo' => 'string'],
    name: 'name',
    perCustomerUsageLimit: 0,
    preserveOnPlanChange: true,
    restrictedTo: ['string'],
    startsAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    subscriptionCycles: 0,
    type: DiscountType::FLAT,
    usageLimit: 0,
  );

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

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

DodoPaymentsClient client = new();

DiscountUpdateParams parameters = new()
{
    DiscountID = "dsc_qxxEmg5PuM1uNTE0LgkP9"
};

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

Console.WriteLine(discount);

use dodopayments::Client;

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

curl --request PATCH \
  --url https://test.dodopayments.com/discounts/{discount_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "code": "<string>",
  "currency_options": [
    {
      "is_default": true,
      "max_amount_possible": 123,
      "minimum_subtotal": 123
    }
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "name": "<string>",
  "per_customer_usage_limit": 123,
  "preserve_on_plan_change": true,
  "restricted_to": [
    "<string>"
  ],
  "starts_at": "2023-11-07T05:31:56Z",
  "subscription_cycles": 123,
  "usage_limit": 123
}
'

200

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

授权

Authorization · string · header · 必填

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

路径参数

discount_id · string · 必填

Discount Id

请求体

application/json

Request body for patching (updating) a discount.

All fields are optional and only update if provided.

amount · integer<int32> | null

If present, update the discount amount in basis points (e.g., 540 = 5.4%, 10000 = 100%).

Must be at least 1 if provided.

code · string | null

If present, update the discount code (uppercase).

currency_options · object[] | null

If present, fully replaces the discount's currency options (replace-set semantics, like restricted_to). Send an empty array to clear them.

Show child attributes

customer_eligibility · null | enum<string>

If present, update who may redeem this discount. Plain field (not double-option): the DB column is NOT NULL, so it can never be cleared back to unset, only changed to another CustomerEligibility value.

可用选项: any, first_time, existing, specific

expires_at · string<date-time> | null

metadata · null | Metadata · object

Additional metadata for the discount

Show child attributes

name · string | null

per_customer_usage_limit · integer<int32> | null

If present, update the per-customer usage limit (double-option: send null to clear it back to unlimited). Must be <= usage_limit (the value in effect after this patch) when both are set.

preserve_on_plan_change · boolean | null

Whether this discount should be preserved when a subscription changes plans. If not provided, the existing value is kept.

restricted_to · string[] | null

If present, replaces all restricted product IDs with this new set. To remove all restrictions, send empty array

starts_at · string<date-time> | null

If present, update starts_at (double-option: send null to clear it).

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.

type · null | enum<string>

If present, update the discount type (percentage or flat).

可用选项: flat, percentage

usage_limit · integer<int32> | null

响应

200

application/json

Updated discount

amount · integer<int32> · 必填

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

business_id · string · 必填

The business this discount belongs to.

code · string · 必填

The discount code (up to 16 chars).

created_at · string<date-time> · 必填

Timestamp when the discount is created

customer_eligibility · enum<string> · 必填

Who may redeem this discount code.

可用选项: any, first_time, existing, specific

discount_id · string · 必填

The unique discount ID

metadata · Metadata · object · 必填

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

Show child attributes

preserve_on_plan_change · boolean · 必填

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

restricted_to · string[] · 必填

List of product IDs to which this discount is restricted.

times_used · integer<int32> · 必填

How many times this discount has been used.

type · enum<string> · 必填

The type of discount (percentage or flat).

可用选项: 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.