SubscriptionParams | cryptopay-node

export
interface: SubscriptionParams

Hierarchy

SubscriptionParams

Index

Properties

amount

amount: number

Subscription amount

memberof: SubscriptionParams

currency

currency: string

Subscription amount currency

memberof: SubscriptionParams

Optional custom_id

custom_id?: string

Subscription reference ID in your system

memberof: SubscriptionParams

name

name: string

Subscription name

memberof: SubscriptionParams

payer_email

payer_email: string

Email of the payer

memberof: SubscriptionParams

Optional payer_name

payer_name?: string

Name of the payer

memberof: SubscriptionParams

period

period: SubscriptionPeriod

memberof: SubscriptionParams

period_quantity

period_quantity: number

memberof: SubscriptionParams

Optional product_description

product_description?: string

memberof: SubscriptionParams

Optional product_name

product_name?: string

memberof: SubscriptionParams

starts_at

starts_at: string

memberof: SubscriptionParams

Optional success_redirect_url

success_redirect_url?: string

The URL that the customer will be redirected to upon transaction confirmation

memberof: SubscriptionParams

Optional unsuccess_redirect_url

unsuccess_redirect_url?: string

memberof: SubscriptionParams