@maxio-com/advanced-billing-sdk/dist/cjs/models/subscription.js

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

"use strict";
/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.subscriptionSchema = void 0;
var schema_js_1 = require("../schema.js");
var bankAccountPaymentProfile_js_1 = require("./bankAccountPaymentProfile.js");
var cancellationMethod_js_1 = require("./cancellationMethod.js");
var collectionMethod_js_1 = require("./collectionMethod.js");
var subscriptionSnapDay_js_1 = require("./containers/subscriptionSnapDay.js");
var creditCardPaymentProfile_js_1 = require("./creditCardPaymentProfile.js");
var customer_js_1 = require("./customer.js");
var nestedSubscriptionGroup_js_1 = require("./nestedSubscriptionGroup.js");
var prepaidConfiguration_js_1 = require("./prepaidConfiguration.js");
var pricePointType_js_1 = require("./pricePointType.js");
var product_js_1 = require("./product.js");
var subscriptionIncludedCoupon_js_1 = require("./subscriptionIncludedCoupon.js");
var subscriptionState_js_1 = require("./subscriptionState.js");
exports.subscriptionSchema = (0, schema_js_1.lazy)(function () {
    return (0, schema_js_1.expandoObject)({
        id: ['id', (0, schema_js_1.optional)((0, schema_js_1.number)())],
        state: ['state', (0, schema_js_1.optional)(subscriptionState_js_1.subscriptionStateSchema)],
        balanceInCents: ['balance_in_cents', (0, schema_js_1.optional)((0, schema_js_1.bigint)())],
        totalRevenueInCents: ['total_revenue_in_cents', (0, schema_js_1.optional)((0, schema_js_1.bigint)())],
        productPriceInCents: ['product_price_in_cents', (0, schema_js_1.optional)((0, schema_js_1.bigint)())],
        productVersionNumber: ['product_version_number', (0, schema_js_1.optional)((0, schema_js_1.number)())],
        currentPeriodEndsAt: [
            'current_period_ends_at',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)())),
        ],
        nextAssessmentAt: ['next_assessment_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        trialStartedAt: ['trial_started_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        trialEndedAt: ['trial_ended_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        activatedAt: ['activated_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        expiresAt: ['expires_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        createdAt: ['created_at', (0, schema_js_1.optional)((0, schema_js_1.string)())],
        updatedAt: ['updated_at', (0, schema_js_1.optional)((0, schema_js_1.string)())],
        cancellationMessage: ['cancellation_message', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        cancellationMethod: [
            'cancellation_method',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)(cancellationMethod_js_1.cancellationMethodSchema)),
        ],
        cancelAtEndOfPeriod: [
            'cancel_at_end_of_period',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.boolean)())),
        ],
        canceledAt: ['canceled_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        currentPeriodStartedAt: [
            'current_period_started_at',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)())),
        ],
        previousState: ['previous_state', (0, schema_js_1.optional)(subscriptionState_js_1.subscriptionStateSchema)],
        signupPaymentId: ['signup_payment_id', (0, schema_js_1.optional)((0, schema_js_1.number)())],
        signupRevenue: ['signup_revenue', (0, schema_js_1.optional)((0, schema_js_1.string)())],
        delayedCancelAt: ['delayed_cancel_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        couponCode: ['coupon_code', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        snapDay: ['snap_day', (0, schema_js_1.optional)((0, schema_js_1.nullable)(subscriptionSnapDay_js_1.subscriptionSnapDaySchema))],
        paymentCollectionMethod: [
            'payment_collection_method',
            (0, schema_js_1.optional)(collectionMethod_js_1.collectionMethodSchema),
        ],
        customer: ['customer', (0, schema_js_1.optional)(customer_js_1.customerSchema)],
        product: ['product', (0, schema_js_1.optional)(product_js_1.productSchema)],
        creditCard: ['credit_card', (0, schema_js_1.optional)(creditCardPaymentProfile_js_1.creditCardPaymentProfileSchema)],
        group: ['group', (0, schema_js_1.optional)((0, schema_js_1.nullable)(nestedSubscriptionGroup_js_1.nestedSubscriptionGroupSchema))],
        bankAccount: ['bank_account', (0, schema_js_1.optional)(bankAccountPaymentProfile_js_1.bankAccountPaymentProfileSchema)],
        paymentType: ['payment_type', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        referralCode: ['referral_code', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        nextProductId: ['next_product_id', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        nextProductHandle: ['next_product_handle', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        couponUseCount: ['coupon_use_count', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        couponUsesAllowed: ['coupon_uses_allowed', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        reasonCode: ['reason_code', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        automaticallyResumeAt: [
            'automatically_resume_at',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)())),
        ],
        couponCodes: ['coupon_codes', (0, schema_js_1.optional)((0, schema_js_1.array)((0, schema_js_1.string)()))],
        offerId: ['offer_id', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        payerId: ['payer_id', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        currentBillingAmountInCents: [
            'current_billing_amount_in_cents',
            (0, schema_js_1.optional)((0, schema_js_1.bigint)()),
        ],
        productPricePointId: ['product_price_point_id', (0, schema_js_1.optional)((0, schema_js_1.number)())],
        productPricePointType: [
            'product_price_point_type',
            (0, schema_js_1.optional)(pricePointType_js_1.pricePointTypeSchema),
        ],
        nextProductPricePointId: [
            'next_product_price_point_id',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)())),
        ],
        netTerms: ['net_terms', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)()))],
        storedCredentialTransactionId: [
            'stored_credential_transaction_id',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.number)())),
        ],
        reference: ['reference', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        onHoldAt: ['on_hold_at', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        prepaidDunning: ['prepaid_dunning', (0, schema_js_1.optional)((0, schema_js_1.boolean)())],
        coupons: ['coupons', (0, schema_js_1.optional)((0, schema_js_1.array)(subscriptionIncludedCoupon_js_1.subscriptionIncludedCouponSchema))],
        dunningCommunicationDelayEnabled: [
            'dunning_communication_delay_enabled',
            (0, schema_js_1.optional)((0, schema_js_1.boolean)()),
        ],
        dunningCommunicationDelayTimeZone: [
            'dunning_communication_delay_time_zone',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)())),
        ],
        receivesInvoiceEmails: [
            'receives_invoice_emails',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.boolean)())),
        ],
        locale: ['locale', (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)()))],
        currency: ['currency', (0, schema_js_1.optional)((0, schema_js_1.string)())],
        scheduledCancellationAt: [
            'scheduled_cancellation_at',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)((0, schema_js_1.string)())),
        ],
        creditBalanceInCents: ['credit_balance_in_cents', (0, schema_js_1.optional)((0, schema_js_1.bigint)())],
        prepaymentBalanceInCents: [
            'prepayment_balance_in_cents',
            (0, schema_js_1.optional)((0, schema_js_1.bigint)()),
        ],
        prepaidConfiguration: [
            'prepaid_configuration',
            (0, schema_js_1.optional)((0, schema_js_1.nullable)(prepaidConfiguration_js_1.prepaidConfigurationSchema)),
        ],
        selfServicePageToken: ['self_service_page_token', (0, schema_js_1.optional)((0, schema_js_1.string)())],
    });
});
//# sourceMappingURL=subscription.js.map