orb-billing/resources/coupons/subscriptions.d.ts

The official TypeScript library for the Orb API

import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as SubscriptionsAPI from "../subscriptions.js";
import { SubscriptionsPage } from "../subscriptions.js";
import { type PageParams } from "../../pagination.js";
/**
 * A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users.
 */
export declare class Subscriptions extends APIResource {
    /**
     * This endpoint returns a list of all subscriptions that have redeemed a given
     * coupon as a [paginated](/api-reference/pagination) list, ordered starting from
     * the most recently created subscription. For a full discussion of the
     * subscription resource, see [Subscription](/core-concepts#subscription).
     */
    list(couponId: string, query?: SubscriptionListParams, options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription>;
    list(couponId: string, options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription>;
}
export interface SubscriptionListParams extends PageParams {
}
export declare namespace Subscriptions {
    export { type SubscriptionListParams as SubscriptionListParams };
}
export { SubscriptionsPage };
//# sourceMappingURL=subscriptions.d.ts.map