import type { billing_SubscriptionFields } from './billing_SubscriptionFields'; import type { billingutils_BillingPeriodType } from './billingutils_BillingPeriodType'; import type { line_item_LineItem } from './line_item_LineItem'; import type { payment_PaymentMethodPreference } from './payment_PaymentMethodPreference'; export type subscription_Subscription = { /** * StripeObject would hold field from stripe's subscription or subscription schedule object */ additionalFields?: Record; /** * CancelledAt is the RFC 3339 timestamp at which the subscription was cancelled; absent while active. */ cancelledAt?: string; /** * ClientID is the ID of the client user the subscription bills. */ clientId?: string; /** * CollectionMethod determines how the subscription's invoices are collected. */ collectionMethod?: subscription_Subscription.collectionMethod; /** * CompanyID is the ID of the company the subscription bills. */ companyId?: string; createdAt?: string; creatorId?: string; /** * Currency is the ISO 4217 currency code the subscription is billed in. */ currency?: string; data?: string; /** * DaysUntilDue is the number of days a recipient has to pay an invoice when collected by sending an invoice. */ daysUntilDue?: number; fields?: billing_SubscriptionFields; /** * {client_id}/INBOX_NOTIFICATION */ filteredListIndexPkey?: string; /** * ForcePaused indicates the subscription was paused because the workspace plan lapsed. */ forcePaused?: boolean; id?: string; identityId?: string; /** * Interval is the billing period the subscription recurs on. */ interval?: billingutils_BillingPeriodType; /** * IntervalCount is the number of intervals between each billing cycle. */ intervalCount?: number; /** * LineItems are the products and ad-hoc charges billed on each cycle. */ lineItems?: Array; /** * Memo is an optional note shown to the recipient on generated invoices. */ memo?: string; object?: string; /** * field is only used for platform api and should not be used anywhere else on FE/BE */ paymentMethodPreferences?: Array; /** * PaymentSourceId is the ID of the saved payment source charged for automatically-collected subscriptions. */ paymentSourceId?: string; previousAttributes?: Record; /** * RecipientID is the ID of the client or company the subscription bills. * Deprecated: use ClientID and CompanyID instead */ recipientId?: string; ref?: string; /** * Status is the current lifecycle status of the subscription, mirrored from Stripe. */ status?: string; /** * TaxPercentage is the tax rate applied to the subscription, as a percentage. */ taxPercentage?: number; /** * TemplateID is the ID of the subscription template the subscription was created from, when applicable. */ templateId?: string; updatedAt?: string; }; export declare namespace subscription_Subscription { /** * CollectionMethod determines how the subscription's invoices are collected. */ enum collectionMethod { SEND_INVOICE = "sendInvoice", CHARGE_AUTOMATICALLY = "chargeAutomatically" } }