Interface SubscriptionUpdateParams

Export

SubscriptionUpdateParams

Hierarchy

  • SubscriptionUpdateParams

Properties

cancel_at? metadata? pause_at? payment_method_id? platform_fee_amount? price? resume_at?

Properties

Optional cancel_at

cancel_at?: string

A date in the future at which the subscription will automatically get canceled.

Memberof

SubscriptionUpdateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

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 (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

SubscriptionUpdateParams

Type declaration

  • [key: string]: string

Optional pause_at

pause_at?: string

The date in the future at which the subscription will automatically be paused.

Memberof

SubscriptionUpdateParams

Optional payment_method_id

payment_method_id?: string

The id of the PaymentMethod used for this subscription. It must belong to the customer associated with the subscription.

Memberof

SubscriptionUpdateParams

Optional platform_fee_amount

platform_fee_amount?: number

The amount of the fee (if any) that will be requested to be applied to the payment and transferred to the partner account. The amount of the fee collected will be capped a the total payment amount.

Memberof

SubscriptionUpdateParams

Optional price

price?: number

Amount intended to be collected by this subscription. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Memberof

SubscriptionUpdateParams

Optional resume_at

resume_at?: string

The date in the future at which the subscription will automatically return to active.

Memberof

SubscriptionUpdateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc