Mayson Monorepo Documentation
    Preparing search index...
    Index

    Properties

    description?: string

    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

    All invoices will be billed using the specified settings.

    metadata?: MetadataParam

    Set of key-value pairs that will declaratively set metadata on Subscriptions generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    trial_period_days?: number

    Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

    Settings related to subscription trials.