@monei-js/node-sdk/dist/src/model/create-subscription-request.d.ts

Node.js SDK for MONEI Digital Payment Gateway

/**
 * MONEI API v1
 * The MONEI API is organized around REST principles. Our API is designed to be intuitive and developer-friendly.  ### Base URL  All API requests should be made to:  ``` https://api.monei.com/v1 ```  ### Environment  MONEI provides two environments:  - **Test Environment**: For development and testing without processing real payments - **Live Environment**: For processing real transactions in production  ### Client Libraries  We provide official SDKs to simplify integration:  - [PHP SDK](https://github.com/MONEI/monei-php-sdk) - [Python SDK](https://github.com/MONEI/monei-python-sdk) - [Node.js SDK](https://github.com/MONEI/monei-node-sdk) - [Postman Collection](https://postman.monei.com/)  Our SDKs handle authentication, error handling, and request formatting automatically.  You can download the OpenAPI specification from the https://js.monei.com/api/v1/openapi.json and generate your own client library using the [OpenAPI Generator](https://openapi-generator.tech/).  ### Important Requirements  - All API requests must be made over HTTPS - If you are not using our official SDKs, you **must provide a valid `User-Agent` header** with each request - Requests without proper authentication will return a `401 Unauthorized` error  ### Error Handling  The API returns consistent error codes and messages to help you troubleshoot issues. Each response includes a `statusCode` attribute indicating the outcome of your request.  ### Rate Limits  The API implements rate limiting to ensure stability. If you exceed the limits, requests will return a `429 Too Many Requests` status code.
 *
 * The version of the OpenAPI document: 1.7.3
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { PaymentBillingDetails } from './payment-billing-details';
import type { PaymentCustomer } from './payment-customer';
import type { PaymentShippingDetails } from './payment-shipping-details';
import type { SubscriptionInterval } from './subscription-interval';
import type { SubscriptionRetrySchedule } from './subscription-retry-schedule';
/**
 *
 * @export
 * @interface CreateSubscriptionRequest
 */
export interface CreateSubscriptionRequest {
    /**
     * Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).
     * @type {number}
     * @memberof CreateSubscriptionRequest
     */
    amount: number;
    /**
     * Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency.
     * @type {string}
     * @memberof CreateSubscriptionRequest
     */
    currency: string;
    /**
     *
     * @type {SubscriptionInterval}
     * @memberof CreateSubscriptionRequest
     */
    interval: SubscriptionInterval;
    /**
     * Number of intervals between subscription payments.
     * @type {number}
     * @memberof CreateSubscriptionRequest
     */
    intervalCount?: number;
    /**
     * An arbitrary string attached to the subscription. Often useful for displaying to users.
     * @type {string}
     * @memberof CreateSubscriptionRequest
     */
    description?: string;
    /**
     *
     * @type {PaymentCustomer}
     * @memberof CreateSubscriptionRequest
     */
    customer?: PaymentCustomer;
    /**
     *
     * @type {PaymentBillingDetails}
     * @memberof CreateSubscriptionRequest
     */
    billingDetails?: PaymentBillingDetails;
    /**
     *
     * @type {PaymentShippingDetails}
     * @memberof CreateSubscriptionRequest
     */
    shippingDetails?: PaymentShippingDetails;
    /**
     * The end date of the trial period. Measured in seconds since the Unix epoch.
     * @type {number}
     * @memberof CreateSubscriptionRequest
     */
    trialPeriodEnd?: number;
    /**
     * Number of days the trial period lasts.
     * @type {number}
     * @memberof CreateSubscriptionRequest
     */
    trialPeriodDays?: number;
    /**
     *
     * @type {SubscriptionRetrySchedule}
     * @memberof CreateSubscriptionRequest
     */
    retrySchedule?: SubscriptionRetrySchedule;
    /**
     * The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.
     * @type {string}
     * @memberof CreateSubscriptionRequest
     */
    callbackUrl?: string;
    /**
     * The URL will be called each time subscription creates a new payments. You will receive the payment object in the body of the request.
     * @type {string}
     * @memberof CreateSubscriptionRequest
     */
    paymentCallbackUrl?: string;
    /**
     * A set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.
     * @type {object}
     * @memberof CreateSubscriptionRequest
     */
    metadata?: object;
}