@paritydeals/node-sdk
Version:
Node.js SDK for interacting with the ParityDeals API.
28 lines • 1.15 kB
TypeScript
import type { ParityDeals } from './client';
import { CreateCheckoutSessionPayload, // This interface itself defines all parameters for createSession
CreateCheckoutSessionResponse } from './models';
/**
* Handles 'checkout' related API operations.
* This class is instantiated by the ParityDeals client and accessed
* via `client.checkout`. All methods are asynchronous.
*/
export declare class CheckoutOperations {
private client;
constructor(client: ParityDeals);
/**
* Creates a new checkout session.
* @param params - Parameters for creating a checkout session, matching the CreateCheckoutSessionPayload interface.
* - pricingTableId: string
* - ruleId: string
* - chargePeriod: ChargePeriod
* - customerId: string
* - features: FeatureListItem[]
* - planIdentifier: string
* - successUrl: string
* - offeringId?: string | null
* - ipAddress?: string | null
* @returns A Promise resolving to CreateCheckoutSessionResponse.
*/
createSession(params: CreateCheckoutSessionPayload): Promise<CreateCheckoutSessionResponse>;
}
//# sourceMappingURL=checkout.d.ts.map