Obtenir une remise par code - Dodo Payments Documentation

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);

{ "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, "expires_at": "2023-11-07T05:31:56Z", "name": "<string>", "subscription_cycles": 123, "usage_limit": 123 }

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

code

string

requis

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

Réponse

Fetched discount by code

amount

integer<int32>

requis

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

business_id

string

requis

The business this discount belongs to.

code

string

requis

The discount code (up to 16 chars).

created_at

string<date-time>

requis

Timestamp when the discount is created

discount_id

string

requis

The unique discount ID

metadata

object

requis

Show child attributes

preserve_on_plan_change

boolean

requis

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

restricted_to

string[]

requis

List of product IDs to which this discount is restricted.

times_used

integer<int32>

requis

How many times this discount has been used.

type

enum<string>

requis

The type of discount. Currently only percentage is supported.

Options disponibles:

percentage

expires_at

string<date-time> | null

Optional date/time after which discount is expired.

name

string | null

Name for the Discount

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.