@getopenpay/client/models/UpdatePriceRequest.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { PriceTypeEnum } from './PriceTypeEnum';
import type { UsageAggMethodEnum } from './UsageAggMethodEnum';
import type { CalendarIntervalEnum } from './CalendarIntervalEnum';
import type { PriceTierParams } from './PriceTierParams';
import type { UsageTypeEnum } from './UsageTypeEnum';
import type { CurrencyEnum } from './CurrencyEnum';
import type { PricingModel } from './PricingModel';
/**
 *
 * @export
 * @interface UpdatePriceRequest
 */
export interface UpdatePriceRequest {
    /**
     *
     * @type {UsageAggMethodEnum}
     * @memberof UpdatePriceRequest
     */
    aggregateUsage?: UsageAggMethodEnum | null;
    /**
     *
     * @type {CalendarIntervalEnum}
     * @memberof UpdatePriceRequest
     */
    billingInterval?: CalendarIntervalEnum | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    billingIntervalCount?: number | null;
    /**
     * This price can only be purchased in a subscription if subscriptioncontains at least one of these prices.
     * @type {Array<string>}
     * @memberof UpdatePriceRequest
     */
    canOnlyBePurchasedWith?: Array<string>;
    /**
     *
     * @type {boolean}
     * @memberof UpdatePriceRequest
     */
    contractAutoRenew?: boolean | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    contractTermMultiple?: number | null;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof UpdatePriceRequest
     */
    currency?: CurrencyEnum | null;
    /**
     *
     * @type {object}
     * @memberof UpdatePriceRequest
     */
    customFields?: object | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    defaultNetD?: number | null;
    /**
     *
     * @type {string}
     * @memberof UpdatePriceRequest
     */
    internalDescription?: string | null;
    /**
     *
     * @type {boolean}
     * @memberof UpdatePriceRequest
     */
    isActive?: boolean | null;
    /**
     *
     * @type {boolean}
     * @memberof UpdatePriceRequest
     */
    isExclusive?: boolean | null;
    /**
     * When listed_exclusively_for_customers is passed only customers under listed_exclusively_for_customers can list the given price. Anyone who has a payment_link containing the price can view and subscribe the prices regardless of it.Please do not pass a value if a price is not exclusive.
     * @type {Array<string>}
     * @memberof UpdatePriceRequest
     */
    listedExclusivelyForCustomers?: Array<string>;
    /**
     *
     * @type {object}
     * @memberof UpdatePriceRequest
     */
    meta?: object | null;
    /**
     *
     * @type {string}
     * @memberof UpdatePriceRequest
     */
    meterId?: string | null;
    /**
     *
     * @type {string}
     * @memberof UpdatePriceRequest
     */
    name?: string | null;
    /**
     * List of price_tiers.
     * @type {Array<PriceTierParams>}
     * @memberof UpdatePriceRequest
     */
    priceTiers?: Array<PriceTierParams>;
    /**
     *
     * @type {PriceTypeEnum}
     * @memberof UpdatePriceRequest
     */
    priceType?: PriceTypeEnum | null;
    /**
     *
     * @type {PricingModel}
     * @memberof UpdatePriceRequest
     */
    pricingModel?: PricingModel | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    transformQuantityDivideBy?: number | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    trialPeriodDays?: number | null;
    /**
     *
     * @type {number}
     * @memberof UpdatePriceRequest
     */
    unitAmountAtom?: number | null;
    /**
     *
     * @type {UsageTypeEnum}
     * @memberof UpdatePriceRequest
     */
    usageType?: UsageTypeEnum | null;
}
/**
 * Check if a given object implements the UpdatePriceRequest interface.
 */
export declare function instanceOfUpdatePriceRequest(value: object): value is UpdatePriceRequest;
export declare function UpdatePriceRequestFromJSON(json: any): UpdatePriceRequest;
export declare function UpdatePriceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdatePriceRequest;
export declare function UpdatePriceRequestToJSON(json: any): UpdatePriceRequest;
export declare function UpdatePriceRequestToJSONTyped(value?: UpdatePriceRequest | null, ignoreDiscriminator?: boolean): any;