Mayson Monorepo Documentation
    Preparing search index...

    Interface OrderCreateParams

    interface OrderCreateParams {
        product: string;
        amount?: number;
        beneficiary?: Stripe.Climate.OrderCreateParams.Beneficiary;
        currency?: string;
        expand?: string[];
        metadata?: MetadataParam;
        metric_tons?: string;
    }
    Index

    Properties

    product amount? beneficiary? currency? expand? metadata? metric_tons?

    Properties

    product: string

    Unique identifier of the Climate product.

    amount?: number

    Requested amount of carbon removal units. Either this or metric_tons must be specified.

    beneficiary?: Stripe.Climate.OrderCreateParams.Beneficiary

    Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.

    currency?: string

    Request currency for the order as a three-letter ISO currency code, in lowercase. Must be a supported settlement currency for your account. If omitted, the account's default currency will be used.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    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.

    metric_tons?: string

    Requested number of tons for the order. Either this or amount must be specified.

    Settings

    Member Visibility

    On This Page

    Properties