Mayson Monorepo Documentation
    Preparing search index...
    interface PlanUpdateParams {
        active?: boolean;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
        nickname?: string;
        product?: string;
        trial_period_days?: number;
    }
    Index

    Properties

    active?: boolean

    Whether the plan is currently available for new subscriptions.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    nickname?: string

    A brief description of the plan, hidden from customers.

    product?: string

    The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.

    trial_period_days?: number

    Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.