orb-billing
Version:
The official TypeScript library for the Orb API
34 lines • 1.72 kB
text/typescript
import { APIResource } from "../../core/resource.mjs";
import * as SubscriptionsAPI from "../subscriptions.mjs";
import { SubscriptionsPage } from "../subscriptions.mjs";
import { type PageParams, PagePromise } from "../../core/pagination.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
/**
* 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).
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const subscription of client.coupons.subscriptions.list(
* 'coupon_id',
* )) {
* // ...
* }
* ```
*/
list(couponID: string, query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription>;
}
export interface SubscriptionListParams extends PageParams {
}
export declare namespace Subscriptions {
export { type SubscriptionListParams as SubscriptionListParams };
}
export { type SubscriptionsPage };
//# sourceMappingURL=subscriptions.d.mts.map