Skip to main content
Discount codes let you offer percentage-based or fixed-amount discounts on payment links. Create individual codes, bulk-generate batches, and validate codes at checkout time.
Discount code management requires admin permission. The /validate endpoint requires read permission, making it safe to call from client-side checkout flows.

Authentication

Base URL: https://platform-api.anyspend.com/api/v1

Endpoints

List Discount Codes

read
List all discount codes with optional filtering and pagination.
Search by code string (case-insensitive partial match).
boolean
Filter by active status. Omit to return all codes.
number
Page number for pagination (default: 1).
number
Results per page (default: 20, max: 100).
Response

Create Discount Code

admin
Create a single discount code.
string
required
The discount code string (e.g., SUMMER25). Must be unique. Automatically uppercased.
string
required
Discount type: percentage or fixed.
number
required
Discount value. For percentage, a number between 1-100. For fixed, the amount in the token’s smallest unit (e.g., 5000000 for 5 USDC).
Restrict this code to a specific payment link. If omitted, the code works on all payment links.
number
Maximum number of times this code can be redeemed. Omit for unlimited uses.
string
Minimum order amount required to use this code, in the token’s smallest unit.
string
ISO 8601 expiration timestamp. Omit for a code that never expires.
Response

Update Discount Code

admin
Update an existing discount code. All fields are optional.

Delete Discount Code

admin
Permanently delete a discount code. Active sessions using this code will not be affected.

Validate Discount Code

read
Validate a discount code against a payment link and order amount. Returns the discount details if valid, or an error message explaining why the code is invalid.
string
required
The discount code to validate.
The payment link the code is being applied to.
string
required
The order amount in the token’s smallest unit, used to check min_order_amount and calculate the discounted total.
Valid Response
Invalid Response
The validate endpoint does not consume a use. Uses are only counted when a payment is completed with the discount applied.

Batch Create Discount Codes

admin
Bulk-create multiple discount codes at once with shared configuration. Useful for generating promotional campaigns or unique single-use codes.
string[]
required
Array of code strings to create. Each must be unique.
string
required
Discount type applied to all codes: percentage or fixed.
number
required
Discount value applied to all codes.
Restrict all codes to a specific payment link.
number
Maximum uses per code. Set to 1 for single-use codes.
string
Minimum order amount for all codes.
string
ISO 8601 expiration timestamp for all codes.
Response

Discount Code Object

Validation Rules

A discount code is considered invalid if any of the following are true: