Update Discount - Dodo Payments Documentation

PATCH

/

discounts

/

{discount_id}

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('discount_id');

console.log(discount.business_id);

{
  "amount": 123,
  "business_id": "<string>",
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "discount_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "restricted_to": [
    "<string>"
  ],
  "times_used": 123,
  "type": "percentage",
  "usage_limit": 123
}

Authorizations

Authorization

string

header

required

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

Path Parameters

discount_id

string

required

Discount Id

Body

application/json

Request body for patching (updating) a discount.

All fields are optional and only update if provided.

Response

200

application/json

Updated discount

The response is of type object.

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('discount_id');

console.log(discount.business_id);

{
  "amount": 123,
  "business_id": "<string>",
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "discount_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "restricted_to": [
    "<string>"
  ],
  "times_used": 123,
  "type": "percentage",
  "usage_limit": 123
}

PATCH

/

discounts

/

{discount_id}

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('discount_id');

console.log(discount.business_id);

{
  "amount": 123,
  "business_id": "<string>",
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "discount_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "restricted_to": [
    "<string>"
  ],
  "times_used": 123,
  "type": "percentage",
  "usage_limit": 123
}

Authorizations

Authorization

string

header

required

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

Path Parameters

discount_id

string

required

Discount Id

Body

application/json

Request body for patching (updating) a discount.

All fields are optional and only update if provided.

Response

200

application/json

Updated discount

The response is of type object.

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('discount_id');

console.log(discount.business_id);

{
  "amount": 123,
  "business_id": "<string>",
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "discount_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "restricted_to": [
    "<string>"
  ],
  "times_used": 123,
  "type": "percentage",
  "usage_limit": 123
}