Mayson Monorepo Documentation
    Preparing search index...

    Interface SubscriptionData

    interface SubscriptionData {
        application_fee_percent?: number;
        billing_cycle_anchor?: number;
        billing_mode?: Stripe.Checkout.SessionCreateParams.SubscriptionData.BillingMode;
        default_tax_rates?: string[];
        description?: string;
        invoice_settings?: Stripe.Checkout.SessionCreateParams.SubscriptionData.InvoiceSettings;
        metadata?: MetadataParam;
        on_behalf_of?: string;
        proration_behavior?: Stripe.Checkout.SessionCreateParams.SubscriptionData.ProrationBehavior;
        transfer_data?: Stripe.Checkout.SessionCreateParams.SubscriptionData.TransferData;
        trial_end?: number;
        trial_period_days?: number;
        trial_settings?: Stripe.Checkout.SessionCreateParams.SubscriptionData.TrialSettings;
    }
    Index

    Properties

    application_fee_percent? billing_cycle_anchor? billing_mode? default_tax_rates? description? invoice_settings? metadata? on_behalf_of? proration_behavior? transfer_data? trial_end? trial_period_days? trial_settings?

    Properties

    application_fee_percent?: number

    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

    billing_cycle_anchor?: number

    A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if ui_mode is custom.

    billing_mode?: Stripe.Checkout.SessionCreateParams.SubscriptionData.BillingMode

    Controls how prorations and invoices for subscriptions are calculated and orchestrated.

    default_tax_rates?: string[]

    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

    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 the customer portal.

    invoice_settings?: Stripe.Checkout.SessionCreateParams.SubscriptionData.InvoiceSettings

    All invoices will be billed using the specified settings.

    metadata?: MetadataParam

    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.

    on_behalf_of?: string

    The account on behalf of which to charge, for each of the subscription's invoices.

    proration_behavior?: Stripe.Checkout.SessionCreateParams.SubscriptionData.ProrationBehavior

    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.

    transfer_data?: Stripe.Checkout.SessionCreateParams.SubscriptionData.TransferData

    If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

    trial_end?: number

    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

    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.

    trial_settings?: Stripe.Checkout.SessionCreateParams.SubscriptionData.TrialSettings

    Settings related to subscription trials.

    Settings

    Member Visibility

    On This Page

    Properties