Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Discount Id
Body
Request body for patching (updating) a discount.
All fields are optional and only update if provided.
If present, update the discount amount:
- If
discount_type
ispercentage
, this represents basis points (e.g.,540
=5.4%
). - Otherwise, this represents USD cents (e.g.,
100
=$1.00
).
Must be at least 1 if provided.
If present, update the discount code (uppercase).
If present, replaces all restricted product IDs with this new set. To remove all restrictions, send empty array
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.
If present, update the discount type.
percentage
Response
Updated discount
The discount amount.
- If
discount_type
ispercentage
, this is in basis points (e.g., 540 => 5.4%). - Otherwise, this is USD cents (e.g., 100 =>
$1.00
).
The business this discount belongs to.
The discount code (up to 16 chars).
Timestamp when the discount is created
The unique discount ID
List of product IDs to which this discount is restricted.
How many times this discount has been used.
The type of discount, e.g. percentage
, flat
, or flat_per_unit
.
percentage
Optional date/time after which discount is expired.
Name for the Discount
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 for this discount, if any.