Nurama Developers
Namespaces

payment

Methods and types of the `payment` namespace (`client.payment` / `bot.payment`).

Interfaces

ManualCheckoutRequest

Properties

PropertyType
billingPeriod"month" | "year"
currency"usd" | "gbp"
productIdstring
resourceIdstring

StripeCheckoutRequest

Properties

PropertyType
billingPeriod"month" | "year"
currency"usd" | "gbp"
productIdstring
resourceIdstring

StripeCheckoutResponse

Properties

PropertyType
urlstring

StripeCustomerResponse

Properties

PropertyType
customerIdstring

StripePortalResponse

Properties

PropertyType
urlstring

Functions

default()

function default(client): {
  createManualCheckout: Promise<any>;
  createStripeCheckout: Promise<StripeCheckoutResponse>;
  createStripeCustomer: Promise<StripeCustomerResponse>;
  getStripePortalUrl: Promise<StripePortalResponse>;
};

Defines payment-related methods for the NuramaClient.

Parameters

ParameterTypeDescription
clientdefaultThe NuramaClient instance.

Returns

An object containing the payment-related methods.

NameTypeDescription
createManualCheckout()(checkoutData) => Promise<any>Create a manual subscription without Stripe processing. Requires authentication and permission.
createStripeCheckout()(checkoutData) => Promise<StripeCheckoutResponse>Create a Stripe subscription checkout session. Requires authentication and permission.
createStripeCustomer()() => Promise<StripeCustomerResponse>Create a new Stripe customer for the authenticated user. Requires authentication and permission.
getStripePortalUrl()() => Promise<StripePortalResponse>Generate a URL for the Stripe customer portal for subscription management. Requires authentication and permission.

On this page