wallee/build/src/models/ShopifySubscriptionProduct.d.ts

TypeScript/JavaScript client for wallee

import { ShopifySubscriptionBillingIntervalUnit } from "./ShopifySubscriptionBillingIntervalUnit";
import { ShopifySubscriptionProductPricingOption } from "./ShopifySubscriptionProductPricingOption";
import { ShopifySubscriptionProductState } from "./ShopifySubscriptionProductState";
import { ShopifySubscriptionWeekday } from "./ShopifySubscriptionWeekday";
declare class ShopifySubscriptionProduct {
    /**
    *
    */
    'absolutePriceAdjustment'?: number;
    /**
    * Define the day of the month on which the recurring orders should be created.
    */
    'billingDayOfMonth'?: number;
    /**
    *
    */
    'billingIntervalAmount'?: number;
    /**
    * Define how frequently recurring orders should be created.
    */
    'billingIntervalUnit'?: ShopifySubscriptionBillingIntervalUnit;
    /**
    * Define the weekday on which the recurring orders should be created.
    */
    'billingWeekday'?: ShopifySubscriptionWeekday;
    /**
    *
    */
    'fixedPrice'?: number;
    /**
    * A unique identifier for the object.
    */
    'id'?: number;
    /**
    * The ID of the space this object belongs to.
    */
    'linkedSpaceId'?: number;
    /**
    * Define the maximum number of orders the subscription will run for.
    */
    'maximalBillingCycles'?: number;
    /**
    * Define the maximum number of orders the subscription can be suspended for at a time.
    */
    'maximalSuspendableCycles'?: number;
    /**
    * Define the minimal number of orders the subscription will run for.
    */
    'minimalBillingCycles'?: number;
    /**
    * The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    */
    'plannedPurgeDate'?: Date;
    /**
    *
    */
    'pricingOption'?: ShopifySubscriptionProductPricingOption;
    /**
    * The ID of the Shopify product that is enabled to be ordered as subscription.
    */
    'productId'?: string;
    /**
    * The legacy ID of the Shopify product that is enabled to be ordered as subscription.
    */
    'productLegacyId'?: string;
    /**
    *
    */
    'productName'?: string;
    /**
    *
    */
    'productPrice'?: number;
    /**
    *
    */
    'productSku'?: string;
    /**
    *
    */
    'productVariantId'?: string;
    /**
    *
    */
    'productVariantLegacyId'?: string;
    /**
    *
    */
    'productVariantName'?: string;
    /**
    *
    */
    'relativePriceAdjustment'?: number;
    /**
    *
    */
    'shippingRequired'?: boolean;
    /**
    *
    */
    'shop'?: number;
    /**
    * The object's current state.
    */
    'state'?: ShopifySubscriptionProductState;
    /**
    *
    */
    'stockCheckRequired'?: boolean;
    /**
    * Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.
    */
    'storeOrderConfirmationEmailEnabled'?: boolean;
    /**
    * Define whether the customer is allowed to suspend subscriptions.
    */
    'subscriberSuspensionAllowed'?: boolean;
    /**
    * Define the number of orders the subscription will keep running for after its termination has been requested.
    */
    'terminationBillingCycles'?: number;
    /**
    *
    */
    'updatedAt'?: Date;
    /**
    * The version is used for optimistic locking and incremented whenever the object is updated.
    */
    'version'?: number;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export { ShopifySubscriptionProduct };