declastruct-stripe-sdk/dist/domain/objects/DeclaredStripeDiscountCoupon.d.ts

declarative control of stripe constructs, via declastruct

import { Price } from 'domain-glossary-price';
import { DomainEntity, DomainLiteral } from 'domain-objects';
/**
 * .what = a declarative structure which represents a Stripe Coupon
 *
 * ref
 * - https://docs.stripe.com/api/coupons/object
 */
export interface DeclaredStripeDiscountCoupon {
    /**
     * the public stripe id of this entity
     */
    id?: string;
    /**
     * The coupon’s name, meant to be displayable to the customer.
     *
     * note
     * - this is displayed on invoices && receipts
     */
    name: null | string;
    /**
     * the price to discount, if an absolute number
     *
     * note
     * - either amountOff or percentOff must be specified
     */
    amountOff: null | Price;
    /**
     * the percent to discount, if a relative number
     *
     * note
     * - either amountOff or percentOff must be specified
     */
    percentOff: null | number;
    /**
     * how long this discount will apply
     */
    duration: 'once' | 'forever' | {
        choice: 'repeating';
        months: number;
    };
    /**
     * metadata about the item which can be used to crossreference information, if any
     */
    metadata: null | Record<string, string>;
}
export declare class DeclaredStripeDiscountCoupon extends DomainEntity<DeclaredStripeDiscountCoupon> implements DeclaredStripeDiscountCoupon {
    static primary: readonly ["id"];
    static nested: {
        metadata: typeof DomainLiteral;
    };
}