Interface WebPackage

One package slot of an offering, as GET /v1/offerings serves it.

interface WebPackage {
    accessIds: string[];
    displayName: string;
    identifier: string;
    isPromoted: boolean;
    metadata: unknown;
    order: number;
    packageIdentifier: string;
    storeIds: Record<string, string>;
    type: string;
}

Properties

accessIds: string[]

Identifiers of the accesses (entitlements) a purchase grants.

displayName: string

The product's display name as configured in the dashboard.

identifier: string

The product's own identifier. Not accepted by checkout().

isPromoted: boolean

Whether the dashboard marked this package as the one to highlight.

metadata: unknown

Free-form metadata set on this package slot in the offering.

order: number

The package's position within its offering, ascending.

packageIdentifier: string

The package slot id — what Rovenue.checkout takes as packageIdentifier.

storeIds: Record<string, string>

The product's store identifiers, keyed by store (e.g. stripe).

type: string

The product type, e.g. SUBSCRIPTION. Web checkout sells subscriptions only.