--- title: "Retrieve an email list." method: GET path: "/api/v1/email/lists/{emailListUid}" tags: ["Email"] --- # Retrieve an email list. `GET /api/v1/email/lists/{emailListUid}` ## Request - Base URL: `https://go.outseta.com` - URL: `https://go.outseta.com/api/v1/email/lists/{emailListUid}` - Auth: one of: - HTTP bearer - API key in header `Authorization` ## Path parameters - `emailListUid` string, nullable, required ## Response `200` - EmailList - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `Description` string, nullable - `WelcomeSubject` string, nullable - `WelcomeBody` string, nullable - `WelcomeFromName` string, nullable - `WelcomeFromEmail` string, nullable - `RequiresDoubleOptIn` boolean - `IsInternal` boolean - `EmailListPerson` EmailListPerson[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `EmailList` EmailList (recursive) - `Person` Person - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `Email` string, email, nullable - `FirstName` string, nullable - `LastName` string, nullable - `MailingAddress` Address - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `AddressLine1` string, nullable - `AddressLine2` string, nullable - `AddressLine3` string, nullable - `City` string, nullable - `State` string, nullable - `PostalCode` string, nullable - `Country` string, nullable - `GeoLocation` string, nullable - `PasswordLastUpdated` string, date-time, nullable - `PasswordMustChange` boolean - `PhoneMobile` string, nullable - `PhoneWork` string, nullable - `ProfileImageS3Url` string, nullable - `Title` string, nullable - `Timezone` string, nullable - `Language` string, nullable - `IPAddress` string, nullable - `Referer` string, nullable - `UserAgent` string, nullable - `LastLoginDateTime` string, date-time, nullable - `OAuthGoogleProfileId` string, nullable - `PersonAccount` PersonAccount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Person` Person (recursive) - `Account` Account - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Name` string, required - `ClientIdentifier` string, nullable - `Currency` string, nullable - `InvoiceNotes` string, nullable - `IsDemo` boolean - `BillingAddress` Address - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `AddressLine1` string, nullable - `AddressLine2` string, nullable - `AddressLine3` string, nullable - `City` string, nullable - `State` string, nullable - `PostalCode` string, nullable - `Country` string, nullable - `GeoLocation` string, nullable - `MailingAddress` Address - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `AddressLine1` string, nullable - `AddressLine2` string, nullable - `AddressLine3` string, nullable - `City` string, nullable - `State` string, nullable - `PostalCode` string, nullable - `Country` string, nullable - `GeoLocation` string, nullable - `AccountStage` 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created - `PaymentInformation` PaymentInformation - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Account` Account, required (recursive) - `CustomerToken` string, nullable - `LastFourDigits` string, nullable - `LatestFailureDateTime` string, date-time, nullable - `LatestFailureDescription` string, nullable - `LatestSuccessDateTime` string, date-time, nullable - `NumberOfFailures` integer, required - `PaymentClientSecret` string, nullable - `PaymentMethodType` string, nullable - `PaymentToken` string, nullable - `BankName` string, nullable - `BankAccountType` string, nullable - `BankAccountHolderType` string, nullable - `NameOnCard` string, nullable - `CardType` string, nullable - `ExpirationMonth` string, nullable - `ExpirationYear` string, nullable - `Mode` string, nullable - `OneTimeToken` string, nullable - `RecaptchaToken` string, nullable - `SetupIntent` string, nullable - `PersonAccount` PersonAccount[], nullable - `StripeDefaultPaymentMethodId` string, nullable - `StripeInvoices` StripeInvoice[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `AmountDue` integer - `AmountPaid` integer - `AmountShipping` integer - `AttemptCount` integer - `Attempted` boolean - `Currency` string, nullable - `Description` string, nullable - `FinalizedAt` string, date-time, nullable - `HostedInvoiceUrl` string, nullable - `InvoicePdf` string, nullable - `NextPaymentAttempt` string, date-time, nullable - `Number` string, nullable - `PeriodEnd` string, date-time - `PeriodStart` string, date-time - `Status` string, nullable - `StripeDiscounts` StripeDiscount[], nullable - … - `StripeInvoiceDiscountAmounts` StripeInvoiceDiscountAmount[], nullable - … - `StripeInvoiceLineItems` StripeInvoiceLineItem[], nullable - … - `StripeInvoicePayments` StripeInvoicePayment[], nullable - … - `SubTotal` integer - `SubTotalExcludingTax` integer, nullable - `SubscriptionId` string, nullable - `Tax` integer, nullable - `Total` integer - `TotalExcludingTax` integer, nullable - `Account` Account (recursive) - `IsImported` boolean - `IsRefunded` boolean - `CurrencyAmountCreditedPostPayment` number - `CurrencyAmountCreditedPrePayment` number - `CurrencyAmountDue` number - `CurrencyAmountPaid` number - `CurrencySymbol` string, nullable - `CurrencyTotal` number - `CurrencyTotalExcludingTax` number - `CurrencySubTotal` number - `CurrencySubTotalExcludingTax` number - `CurrencyTax` number - `DaysUntilDue` integer, nullable - `CustomerId` string, nullable - `PaymentStatus` string, nullable - `StripeCreditNotes` StripeCreditNote[], nullable - … - `StripePaymentMethodId` string, nullable - `StripePaymentMethods` StripePaymentMethod[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `Card_Brand` string, nullable - `Card_ExpMonth` integer, nullable - `Card_ExpYear` integer, nullable - `Card_Wallet_Type` string, nullable - `BankName` string, nullable - `Last4` string, nullable - `Type` string, nullable - `Label` string, nullable - `StripeSubscriptions` StripeSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `ApplicationFeePercent` number, nullable - `CancelAt` string, date-time, nullable - `CancelAtPeriodEnd` boolean - `StripeSubscriptionCancellation` StripeSubscriptionCancellation - … - `Currency` string, nullable - `EndedAt` string, date-time, nullable - `PauseCollection_Behavior` string, nullable - `PauseCollection_ResumesAt` string, date-time, nullable - `StartDate` string, date-time - `Status` string, nullable - `TrialEnd` string, date-time, nullable - `StripeDiscounts` StripeDiscount[], nullable - … - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable - … - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable - … - `Account` Account (recursive) - `AccountUid` string, nullable - `BillingCycleAnchor` string, date-time, nullable - `CollectionMethod` string, nullable - `CustomerId` string, nullable - `DaysUntilDue` integer, nullable - `ScheduleId` string, nullable - `StripeDiscountIds` string[], nullable - `StripePriceIds` string, nullable - `TrialPeriodDays` integer - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule - … - `Subscriptions` Subscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - … - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - … - `Rate` number, nullable - `Deals` Deal[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `Name` string, required - `Amount` number, nullable - `DueDate` string, date-time, nullable - `AssignedToPersonClientIdentifier` string, nullable - `Weight` integer - `DealPipelineStage` DealPipelineStage - … - `Account` Account (recursive) - `DealPeople` DealPerson[], nullable - … - `Contacts` string, nullable - `AccountId` integer - `Owner` Person (recursive) - `PipelineUid` string, nullable - `LastLoginDateTime` string, date-time, nullable - `AccountSpecificPageUrl1` string, nullable - `AccountSpecificPageUrl2` string, nullable - `AccountSpecificPageUrl3` string, nullable - `AccountSpecificPageUrl4` string, nullable - `AccountSpecificPageUrl5` string, nullable - `AccountSpecificPageUrl6` string, nullable - `AccountSpecificPageUrl7` string, nullable - `AccountSpecificPageUrl8` string, nullable - `AccountSpecificPageUrl9` string, nullable - `AccountSpecificPageUrl10` string, nullable - `RewardFulReferralId` string, nullable - `ToltReferralId` string, nullable - `TaxIds` AccountTaxId[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `TaxId` string, nullable - `TaxIdType` string, nullable - `IsInvalid` boolean - `TaxStatus` string, nullable - `AccountStageLabel` string, nullable - `CurrentStripeProducts` string, nullable - `CurrentStripeProductInstances` StripeProduct[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Name` string, nullable - `DefaultPriceId` string, nullable - `Description` string, nullable - `IsActive` boolean - `TaxCodeId` string, nullable - `UnitLabel` string, nullable - `ContentGroups` ContentGroup[], nullable - … - `StripePrices` StripePrice[], nullable - … - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `IsPerUser` boolean - `IsQuantityEditable` boolean - `MaximumPeople` integer, nullable - `MigratedAddOnUid` string, nullable - `MigratedPlanUid` string, nullable - `MinimumQuantity` integer, nullable - `PostLoginPath` string, nullable - `PostPurchaseUrl` string, nullable - `RequirePaymentInformation` boolean - `StripeProductCrossSells` StripeProductCrossSell[], nullable - … - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `CanDelete` boolean - `NumberOfPurchases` integer - `NumberOfSubscriptions` integer - `Quantity` integer, nullable - `StripeProductFamily` StripeProductFamily - … - `CurrentSubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - … - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - … - `Rate` number, nullable - `DomainName` string, nullable - `TenantBillingSystem` 1 | 2: `1` - Outseta, `2` - Stripe - `HasLoggedIn` boolean - `LatestSubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - … - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - … - `Rate` number, nullable - `LifetimeRevenue` number - `NextStripeInvoiceDate` string, date-time, nullable - `Nonce` string, nullable - `PrimaryContact` Person (recursive) - `PrimarySubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - … - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - … - `Rate` number, nullable - `PrimaryStripeSubscription` StripeSubscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `ApplicationFeePercent` number, nullable - `CancelAt` string, date-time, nullable - `CancelAtPeriodEnd` boolean - `StripeSubscriptionCancellation` StripeSubscriptionCancellation - … - `Currency` string, nullable - `EndedAt` string, date-time, nullable - `PauseCollection_Behavior` string, nullable - `PauseCollection_ResumesAt` string, date-time, nullable - `StartDate` string, date-time - `Status` string, nullable - `TrialEnd` string, date-time, nullable - `StripeDiscounts` StripeDiscount[], nullable - … - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable - … - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable - … - `Account` Account (recursive) - `AccountUid` string, nullable - `BillingCycleAnchor` string, date-time, nullable - `CollectionMethod` string, nullable - `CustomerId` string, nullable - `DaysUntilDue` integer, nullable - `ScheduleId` string, nullable - `StripeDiscountIds` string[], nullable - `StripePriceIds` string, nullable - `TrialPeriodDays` integer - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule - … - `RecaptchaToken` string, nullable - `StripeCheckoutMetadata` object, nullable - `StripeNextInvoiceSequence` integer, nullable - `StripePrice` string[], nullable - `StripePriceIds` string, nullable - `StripePromotionCode` string, nullable - `TaxId` string, nullable - `TaxIdIsInvalid` boolean - `TaxIdType` string, nullable - `WebflowSlug` string, nullable - `IsPrimary` boolean - `ReceiveInvoices` boolean - `Role` 1 | 2 | 3: `1` - Admin, `2` - Member, `3` - Operator - `DealPeople` DealPerson[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Person` Person (recursive) - `Deal` Deal - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `Name` string, required - `Amount` number, nullable - `DueDate` string, date-time, nullable - `AssignedToPersonClientIdentifier` string, nullable - `Weight` integer - `DealPipelineStage` DealPipelineStage - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Weight` integer - `Name` string, nullable - `DealPipeline` DealPipeline - … - `Deals` Deal[], nullable - `Account` Account - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Name` string, required - `ClientIdentifier` string, nullable - `Currency` string, nullable - `InvoiceNotes` string, nullable - `IsDemo` boolean - `BillingAddress` Address - … - `MailingAddress` Address - … - `AccountStage` 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created - `PaymentInformation` PaymentInformation - … - `PersonAccount` PersonAccount[], nullable - … - `StripeDefaultPaymentMethodId` string, nullable - `StripeInvoices` StripeInvoice[], nullable - … - `StripePaymentMethods` StripePaymentMethod[], nullable - … - `StripeSubscriptions` StripeSubscription[], nullable - … - `Subscriptions` Subscription[], nullable - … - `Deals` Deal[], nullable - `LastLoginDateTime` string, date-time, nullable - `AccountSpecificPageUrl1` string, nullable - `AccountSpecificPageUrl2` string, nullable - `AccountSpecificPageUrl3` string, nullable - `AccountSpecificPageUrl4` string, nullable - `AccountSpecificPageUrl5` string, nullable - `AccountSpecificPageUrl6` string, nullable - `AccountSpecificPageUrl7` string, nullable - `AccountSpecificPageUrl8` string, nullable - `AccountSpecificPageUrl9` string, nullable - `AccountSpecificPageUrl10` string, nullable - `RewardFulReferralId` string, nullable - `ToltReferralId` string, nullable - `TaxIds` AccountTaxId[], nullable - … - `TaxStatus` string, nullable - `AccountStageLabel` string, nullable - `CurrentStripeProducts` string, nullable - `CurrentStripeProductInstances` StripeProduct[], nullable - … - `CurrentSubscription` Subscription - … - `DomainName` string, nullable - `TenantBillingSystem` 1 | 2: `1` - Outseta, `2` - Stripe - `HasLoggedIn` boolean - `LatestSubscription` Subscription - … - `LifetimeRevenue` number - `NextStripeInvoiceDate` string, date-time, nullable - `Nonce` string, nullable - `PrimaryContact` Person (recursive) - `PrimarySubscription` Subscription - … - `PrimaryStripeSubscription` StripeSubscription - … - `RecaptchaToken` string, nullable - `StripeCheckoutMetadata` object, nullable - `StripeNextInvoiceSequence` integer, nullable - `StripePrice` string[], nullable - `StripePriceIds` string, nullable - `StripePromotionCode` string, nullable - `TaxId` string, nullable - `TaxIdIsInvalid` boolean - `TaxIdType` string, nullable - `WebflowSlug` string, nullable - `DealPeople` DealPerson[], nullable - `Contacts` string, nullable - `AccountId` integer - `Owner` Person (recursive) - `PipelineUid` string, nullable - `LeadFormSubmissions` LeadFormSubmission[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Person` Person, required (recursive) - `LeadForm` LeadForm, required - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `FieldConfigurationDataJSON` string, nullable - `ThankYouRedirectUrl` string, uri, nullable - `SubmissionCount` integer - `PipelineStageUid` string, nullable - `DealPipelineStage` DealPipelineStage - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Weight` integer - `Name` string, nullable - `DealPipeline` DealPipeline - … - `Deals` Deal[], nullable - … - `RefererURL` string, nullable - `HasPendingFields` boolean - `Fields` LeadFormSubmissionField[], nullable - `SystemName` string, nullable - `Value` string, nullable - `Outcome` 'Written' | 'Unchanged' | 'Skipped': `Written` - Saved, `Unchanged` - Unchanged, `Skipped` - Not saved - `PersonValue` string, nullable - `RecaptchaToken` string, nullable - `RecaptchaSiteKey` string, nullable - `Account` Account - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Name` string, required - `ClientIdentifier` string, nullable - `Currency` string, nullable - `InvoiceNotes` string, nullable - `IsDemo` boolean - `BillingAddress` Address - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `AddressLine1` string, nullable - `AddressLine2` string, nullable - `AddressLine3` string, nullable - `City` string, nullable - `State` string, nullable - `PostalCode` string, nullable - `Country` string, nullable - `GeoLocation` string, nullable - `MailingAddress` Address - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `AddressLine1` string, nullable - `AddressLine2` string, nullable - `AddressLine3` string, nullable - `City` string, nullable - `State` string, nullable - `PostalCode` string, nullable - `Country` string, nullable - `GeoLocation` string, nullable - `AccountStage` 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10: `2` - Trialing, `3` - Subscribing, `4` - Cancelling, `5` - Expired, `6` - Trial Expired, `7` - Past Due, `8` - Cancelling Trial, `9` - Paused, `10` - Created - `PaymentInformation` PaymentInformation - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Account` Account, required (recursive) - `CustomerToken` string, nullable - `LastFourDigits` string, nullable - `LatestFailureDateTime` string, date-time, nullable - `LatestFailureDescription` string, nullable - `LatestSuccessDateTime` string, date-time, nullable - `NumberOfFailures` integer, required - `PaymentClientSecret` string, nullable - `PaymentMethodType` string, nullable - `PaymentToken` string, nullable - `BankName` string, nullable - `BankAccountType` string, nullable - `BankAccountHolderType` string, nullable - `NameOnCard` string, nullable - `CardType` string, nullable - `ExpirationMonth` string, nullable - `ExpirationYear` string, nullable - `Mode` string, nullable - `OneTimeToken` string, nullable - `RecaptchaToken` string, nullable - `SetupIntent` string, nullable - `PersonAccount` PersonAccount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Person` Person (recursive) - `Account` Account (recursive) - `IsPrimary` boolean - `ReceiveInvoices` boolean - `Role` 1 | 2 | 3: `1` - Admin, `2` - Member, `3` - Operator - `StripeDefaultPaymentMethodId` string, nullable - `StripeInvoices` StripeInvoice[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `AmountDue` integer - `AmountPaid` integer - `AmountShipping` integer - `AttemptCount` integer - `Attempted` boolean - `Currency` string, nullable - `Description` string, nullable - `FinalizedAt` string, date-time, nullable - `HostedInvoiceUrl` string, nullable - `InvoicePdf` string, nullable - `NextPaymentAttempt` string, date-time, nullable - `Number` string, nullable - `PeriodEnd` string, date-time - `PeriodStart` string, date-time - `Status` string, nullable - `StripeDiscounts` StripeDiscount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `CheckoutSessionId` string, nullable - `End` string, date-time, nullable - `InvoiceId` string, nullable - `InvoiceItemId` string, nullable - `IsDeleted` boolean - `Start` string, date-time - `StripeCoupon` StripeCoupon - … - `StripePromotionCode` StripePromotionCode - … - `SubscriptionId` string, nullable - `SubscriptionItemId` string, nullable - `CouponId` string, nullable - `CustomerId` string, nullable - `StripeInvoice` StripeInvoice (recursive) - `StripeSubscription` StripeSubscription - … - `PromotionCodeId` string, nullable - `StripeInvoiceDiscountAmounts` StripeInvoiceDiscountAmount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Amount` integer - `DiscountId` string, nullable - `StripeInvoice` StripeInvoice (recursive) - `CurrencyAmount` number - `StripeDiscount` StripeDiscount - … - `StripeInvoiceLineItems` StripeInvoiceLineItem[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `StripeInvoice` StripeInvoice (recursive) - `Amount` integer - `Currency` string, nullable - `PeriodStart` string, date-time - `PeriodEnd` string, date-time - `Quantity` integer, nullable - `StripeDiscounts` StripeDiscount[], nullable - … - `StripePrice` StripePrice - … - `EndDate` string, date-time, nullable - `CurrencyAmount` number, nullable - `PriceId` string, nullable - `Proration` boolean - `StripeInvoicePayments` StripeInvoicePayment[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `AmountPaid` integer, nullable - `AmountRequested` integer - `Currency` string, nullable - `Payment_ChargeId` string, nullable - `Payment_PaymentIntentId` string, nullable - `Payment_Type` string, nullable - `StripeInvoice` StripeInvoice (recursive) - `Status` string, nullable - `InvoiceId` string, nullable - `StripeCharges` StripeCharge[], nullable - … - `SubTotal` integer - `SubTotalExcludingTax` integer, nullable - `SubscriptionId` string, nullable - `Tax` integer, nullable - `Total` integer - `TotalExcludingTax` integer, nullable - `Account` Account (recursive) - `IsImported` boolean - `IsRefunded` boolean - `CurrencyAmountCreditedPostPayment` number - `CurrencyAmountCreditedPrePayment` number - `CurrencyAmountDue` number - `CurrencyAmountPaid` number - `CurrencySymbol` string, nullable - `CurrencyTotal` number - `CurrencyTotalExcludingTax` number - `CurrencySubTotal` number - `CurrencySubTotalExcludingTax` number - `CurrencyTax` number - `DaysUntilDue` integer, nullable - `CustomerId` string, nullable - `PaymentStatus` string, nullable - `StripeCreditNotes` StripeCreditNote[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Currency` string, nullable - `CustomerId` string, nullable - `InvoiceId` string, nullable - `OutOfBandAmount` integer, nullable - `PostPaymentAmount` integer - `PrePaymentAmount` integer - `Reason` string, nullable - `Status` string, nullable - `Total` integer - `Type` string, nullable - `CurrencySymbol` string, nullable - `CurrencyTotal` number - `StripePaymentMethodId` string, nullable - `StripePaymentMethods` StripePaymentMethod[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `Card_Brand` string, nullable - `Card_ExpMonth` integer, nullable - `Card_ExpYear` integer, nullable - `Card_Wallet_Type` string, nullable - `BankName` string, nullable - `Last4` string, nullable - `Type` string, nullable - `Label` string, nullable - `StripeSubscriptions` StripeSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `ApplicationFeePercent` number, nullable - `CancelAt` string, date-time, nullable - `CancelAtPeriodEnd` boolean - `StripeSubscriptionCancellation` StripeSubscriptionCancellation - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Comment` string, nullable - `Feedback` string, nullable - `Reason` string, nullable - `Account` Account (recursive) - `CancelationReason` string, nullable - `LastProduct` StripeProduct - … - `SubmittedDateTime` string, date-time - `SubscribingStartDate` string, date-time - `Currency` string, nullable - `EndedAt` string, date-time, nullable - `PauseCollection_Behavior` string, nullable - `PauseCollection_ResumesAt` string, date-time, nullable - `StartDate` string, date-time - `Status` string, nullable - `TrialEnd` string, date-time, nullable - `StripeDiscounts` StripeDiscount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `CheckoutSessionId` string, nullable - `End` string, date-time, nullable - `InvoiceId` string, nullable - `InvoiceItemId` string, nullable - `IsDeleted` boolean - `Start` string, date-time - `StripeCoupon` StripeCoupon - … - `StripePromotionCode` StripePromotionCode - … - `SubscriptionId` string, nullable - `SubscriptionItemId` string, nullable - `CouponId` string, nullable - `CustomerId` string, nullable - `StripeInvoice` StripeInvoice - … - `StripeSubscription` StripeSubscription (recursive) - `PromotionCodeId` string, nullable - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CurrentPeriodStart` string, date-time - `CurrentPeriodEnd` string, date-time - `StripeSubscription` StripeSubscription (recursive) - `StripeDiscounts` StripeDiscount[], nullable - … - `StripePrice` StripePrice - … - `Quantity` integer - `PriceId` string, nullable - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CompletedAt` string, date-time, nullable - `CurrentPhase_EndDate` string, date-time, nullable - `CurrentPhase_StartDate` string, date-time, nullable - `EndBehavior` string, nullable - `StripeSubscriptionSchedulePhases` StripeSubscriptionSchedulePhase[], nullable - … - `ReleasedAt` string, date-time, nullable - `Status` string, nullable - `StripeSubscription` StripeSubscription (recursive) - `SubscriptionId` string, nullable - `ReleasedSubscriptionId` string, nullable - `Account` Account (recursive) - `AccountUid` string, nullable - `BillingCycleAnchor` string, date-time, nullable - `CollectionMethod` string, nullable - `CustomerId` string, nullable - `DaysUntilDue` integer, nullable - `ScheduleId` string, nullable - `StripeDiscountIds` string[], nullable - `StripePriceIds` string, nullable - `TrialPeriodDays` integer - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CompletedAt` string, date-time, nullable - `CurrentPhase_EndDate` string, date-time, nullable - `CurrentPhase_StartDate` string, date-time, nullable - `EndBehavior` string, nullable - `StripeSubscriptionSchedulePhases` StripeSubscriptionSchedulePhase[], nullable - … - `ReleasedAt` string, date-time, nullable - `Status` string, nullable - `StripeSubscription` StripeSubscription (recursive) - `SubscriptionId` string, nullable - `ReleasedSubscriptionId` string, nullable - `Subscriptions` Subscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `Description` string, nullable - `PlanFamily` PlanFamily - … - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `IsQuantityEditable` boolean, required - `MinimumQuantity` integer - `MaximumPeople` integer, nullable - `MonthlyRate` number - `AnnualRate` number - `QuarterlyRate` number - `OneTimeRate` number - `SetupFee` number - `SkipSetupFeeOnPlanChange` boolean - `IsTaxable` boolean, required - `IsActive` boolean - `IsPerUser` boolean - `RequirePaymentInformation` boolean - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `PostLoginPath` string, nullable - `StripeTaxCodeId` string, nullable - `UnitOfMeasure` string, nullable - `PlanAddOns` PlanAddOn[], nullable - … - `ContentGroups` ContentGroup[], nullable - … - `NumberOfSubscriptions` integer, nullable - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Subscription` Subscription (recursive) - `AddOn` AddOn - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `Rate` number, nullable - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `RedeemedDate` string, date-time, nullable - `ExpireDate` string, date-time, nullable - `Subscription` Subscription (recursive) - `DiscountCoupon` DiscountCoupon - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `InvoiceDate` string, date-time - `PaymentReminderSentDate` string, date-time, nullable - `Number` integer - `BillingInvoiceStatus` 1 | 2 | 3 | 4 | 5 | 6 | 7: `1` - Unpaid, `2` - Paid, `3` - Partial, `4` - Uncollected, `5` - Refunded, `6` - Uncollectible, `7` - Processing - `Subscription` Subscription (recursive) - `Amount` number - `AmountOutstanding` number - `InvoiceLineItems` InvoiceLineItem[], nullable - … - `IsUserGenerated` boolean - `StripeTaxCalculationId` string, nullable - `StripeTaxBehavior` string, nullable - `AmountCredit` number - `AmountDiscount` number - `AmountPaid` number - `AmountRefunded` number - `AmountSubtotal` number - `AmountTax` number - `AmountTaxRefunded` number - `IsTaxable` boolean - `HasPaymentGatewayTransactions` boolean - `StripePaymentTransactionIds` string, nullable - `StripeRefundTransactionIds` string, nullable - `StripeTaxRefundTransactionIds` string, nullable - `Rate` number, nullable - `Deals` Deal[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `Name` string, required - `Amount` number, nullable - `DueDate` string, date-time, nullable - `AssignedToPersonClientIdentifier` string, nullable - `Weight` integer - `DealPipelineStage` DealPipelineStage - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Weight` integer - `Name` string, nullable - `DealPipeline` DealPipeline - … - `Deals` Deal[], nullable - `Account` Account (recursive) - `DealPeople` DealPerson[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Person` Person (recursive) - `Deal` Deal (recursive) - `Contacts` string, nullable - `AccountId` integer - `Owner` Person (recursive) - `PipelineUid` string, nullable - `LastLoginDateTime` string, date-time, nullable - `AccountSpecificPageUrl1` string, nullable - `AccountSpecificPageUrl2` string, nullable - `AccountSpecificPageUrl3` string, nullable - `AccountSpecificPageUrl4` string, nullable - `AccountSpecificPageUrl5` string, nullable - `AccountSpecificPageUrl6` string, nullable - `AccountSpecificPageUrl7` string, nullable - `AccountSpecificPageUrl8` string, nullable - `AccountSpecificPageUrl9` string, nullable - `AccountSpecificPageUrl10` string, nullable - `RewardFulReferralId` string, nullable - `ToltReferralId` string, nullable - `TaxIds` AccountTaxId[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `TaxId` string, nullable - `TaxIdType` string, nullable - `IsInvalid` boolean - `TaxStatus` string, nullable - `AccountStageLabel` string, nullable - `CurrentStripeProducts` string, nullable - `CurrentStripeProductInstances` StripeProduct[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Name` string, nullable - `DefaultPriceId` string, nullable - `Description` string, nullable - `IsActive` boolean - `TaxCodeId` string, nullable - `UnitLabel` string, nullable - `ContentGroups` ContentGroup[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, required - `AccessDeniedPath` string, nullable - `ContentGroupItems` ContentGroupItem[], nullable - … - `AllowedPlans` Plan[], nullable - … - `AllowedProducts` StripeProduct[], nullable - `AllowedAddOns` AddOn[], nullable - … - `StripePrices` StripePrice[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `BillingScheme` string, nullable - `Currency` string, nullable - `CustomUnitAmount_Maximum` integer, nullable - `CustomUnitAmount_Minimum` integer, nullable - `CustomUnitAmount_Preset` integer, nullable - `IsActive` boolean - `Nickname` string, nullable - `Recurring_Interval` string, nullable - `Recurring_IntervalCount` integer, nullable - `Recurring_StripeMeter` StripeMeter - … - `Recurring_UsageType` string, nullable - `StripeProduct` StripeProduct (recursive) - `TaxBehavior` string, nullable - `TiersMode` string, nullable - `TransformQuantity_DivideBy` integer, nullable - `Type` string, nullable - `UnitAmount` integer, nullable - `UnitAmountDecimal` number, nullable - `ShowInSignUpForm` boolean - `CurrencySymbol` string, nullable - `CurrencyUnitAmount` number, nullable - `CurrencyUnitAmountDecimal` number, nullable - `Recurring_IntervalDays` integer, nullable - `Recurring_Description` string, nullable - `StripeMeterId` string, nullable - `StripeProductId` string, nullable - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `IsPerUser` boolean - `IsQuantityEditable` boolean - `MaximumPeople` integer, nullable - `MigratedAddOnUid` string, nullable - `MigratedPlanUid` string, nullable - `MinimumQuantity` integer, nullable - `PostLoginPath` string, nullable - `PostPurchaseUrl` string, nullable - `RequirePaymentInformation` boolean - `StripeProductCrossSells` StripeProductCrossSell[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `StripeProduct` StripeProduct (recursive) - `CrossSellProduct` StripeProduct (recursive) - `IsUserSelectable` boolean - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `CanDelete` boolean - `NumberOfPurchases` integer - `NumberOfSubscriptions` integer - `Quantity` integer, nullable - `StripeProductFamily` StripeProductFamily - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `Name` string, nullable - `IsActive` boolean - `IsDefault` boolean - `StripeProducts` StripeProduct[], nullable - `CurrentSubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `Description` string, nullable - `PlanFamily` PlanFamily - … - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `IsQuantityEditable` boolean, required - `MinimumQuantity` integer - `MaximumPeople` integer, nullable - `MonthlyRate` number - `AnnualRate` number - `QuarterlyRate` number - `OneTimeRate` number - `SetupFee` number - `SkipSetupFeeOnPlanChange` boolean - `IsTaxable` boolean, required - `IsActive` boolean - `IsPerUser` boolean - `RequirePaymentInformation` boolean - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `PostLoginPath` string, nullable - `StripeTaxCodeId` string, nullable - `UnitOfMeasure` string, nullable - `PlanAddOns` PlanAddOn[], nullable - … - `ContentGroups` ContentGroup[], nullable - … - `NumberOfSubscriptions` integer, nullable - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Subscription` Subscription (recursive) - `AddOn` AddOn - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `Rate` number, nullable - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `RedeemedDate` string, date-time, nullable - `ExpireDate` string, date-time, nullable - `Subscription` Subscription (recursive) - `DiscountCoupon` DiscountCoupon - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `InvoiceDate` string, date-time - `PaymentReminderSentDate` string, date-time, nullable - `Number` integer - `BillingInvoiceStatus` 1 | 2 | 3 | 4 | 5 | 6 | 7: `1` - Unpaid, `2` - Paid, `3` - Partial, `4` - Uncollected, `5` - Refunded, `6` - Uncollectible, `7` - Processing - `Subscription` Subscription (recursive) - `Amount` number - `AmountOutstanding` number - `InvoiceLineItems` InvoiceLineItem[], nullable - … - `IsUserGenerated` boolean - `StripeTaxCalculationId` string, nullable - `StripeTaxBehavior` string, nullable - `AmountCredit` number - `AmountDiscount` number - `AmountPaid` number - `AmountRefunded` number - `AmountSubtotal` number - `AmountTax` number - `AmountTaxRefunded` number - `IsTaxable` boolean - `HasPaymentGatewayTransactions` boolean - `StripePaymentTransactionIds` string, nullable - `StripeRefundTransactionIds` string, nullable - `StripeTaxRefundTransactionIds` string, nullable - `Rate` number, nullable - `DomainName` string, nullable - `TenantBillingSystem` 1 | 2: `1` - Outseta, `2` - Stripe - `HasLoggedIn` boolean - `LatestSubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `Description` string, nullable - `PlanFamily` PlanFamily - … - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `IsQuantityEditable` boolean, required - `MinimumQuantity` integer - `MaximumPeople` integer, nullable - `MonthlyRate` number - `AnnualRate` number - `QuarterlyRate` number - `OneTimeRate` number - `SetupFee` number - `SkipSetupFeeOnPlanChange` boolean - `IsTaxable` boolean, required - `IsActive` boolean - `IsPerUser` boolean - `RequirePaymentInformation` boolean - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `PostLoginPath` string, nullable - `StripeTaxCodeId` string, nullable - `UnitOfMeasure` string, nullable - `PlanAddOns` PlanAddOn[], nullable - … - `ContentGroups` ContentGroup[], nullable - … - `NumberOfSubscriptions` integer, nullable - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Subscription` Subscription (recursive) - `AddOn` AddOn - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `Rate` number, nullable - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `RedeemedDate` string, date-time, nullable - `ExpireDate` string, date-time, nullable - `Subscription` Subscription (recursive) - `DiscountCoupon` DiscountCoupon - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `InvoiceDate` string, date-time - `PaymentReminderSentDate` string, date-time, nullable - `Number` integer - `BillingInvoiceStatus` 1 | 2 | 3 | 4 | 5 | 6 | 7: `1` - Unpaid, `2` - Paid, `3` - Partial, `4` - Uncollected, `5` - Refunded, `6` - Uncollectible, `7` - Processing - `Subscription` Subscription (recursive) - `Amount` number - `AmountOutstanding` number - `InvoiceLineItems` InvoiceLineItem[], nullable - … - `IsUserGenerated` boolean - `StripeTaxCalculationId` string, nullable - `StripeTaxBehavior` string, nullable - `AmountCredit` number - `AmountDiscount` number - `AmountPaid` number - `AmountRefunded` number - `AmountSubtotal` number - `AmountTax` number - `AmountTaxRefunded` number - `IsTaxable` boolean - `HasPaymentGatewayTransactions` boolean - `StripePaymentTransactionIds` string, nullable - `StripeRefundTransactionIds` string, nullable - `StripeTaxRefundTransactionIds` string, nullable - `Rate` number, nullable - `LifetimeRevenue` number - `NextStripeInvoiceDate` string, date-time, nullable - `Nonce` string, nullable - `PrimaryContact` Person (recursive) - `PrimarySubscription` Subscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Account` Account (recursive) - `Plan` Plan - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Name` string, nullable - `Description` string, nullable - `PlanFamily` PlanFamily - … - `AccountRegistrationMode` 1 | 2: `1` - Individual, `2` - Team - `IsQuantityEditable` boolean, required - `MinimumQuantity` integer - `MaximumPeople` integer, nullable - `MonthlyRate` number - `AnnualRate` number - `QuarterlyRate` number - `OneTimeRate` number - `SetupFee` number - `SkipSetupFeeOnPlanChange` boolean - `IsTaxable` boolean, required - `IsActive` boolean - `IsPerUser` boolean - `RequirePaymentInformation` boolean - `TrialPeriodDays` integer - `TrialUntilDate` string, date-time, nullable - `ExpiresAfterMonths` integer - `ExpirationDate` string, date-time, nullable - `PostLoginPath` string, nullable - `StripeTaxCodeId` string, nullable - `UnitOfMeasure` string, nullable - `PlanAddOns` PlanAddOn[], nullable - … - `ContentGroups` ContentGroup[], nullable - … - `NumberOfSubscriptions` integer, nullable - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `IsPlanUpgradeRequired` boolean - `PlanUpgradeRequiredMessage` string, nullable - `SubscriptionAddOns` SubscriptionAddOn[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `BillingRenewalTerm` 1 | 2 | 3 | 4: `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time - `Subscription` Subscription (recursive) - `AddOn` AddOn - … - `Quantity` integer, nullable - `StartDate` string, date-time - `EndDate` string, date-time, nullable - `ExpirationDate` string, date-time, nullable - `RenewalDate` string, date-time, nullable - `NewRequiredQuantity` integer, nullable - `Rate` number, nullable - `DiscountCouponSubscriptions` DiscountCouponSubscription[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `RedeemedDate` string, date-time, nullable - `ExpireDate` string, date-time, nullable - `Subscription` Subscription (recursive) - `DiscountCoupon` DiscountCoupon - … - `DiscountCode` string, nullable - `DiscountCouponExpirationDate` string, date-time, nullable - `LatestInvoice` Invoice - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `InvoiceDate` string, date-time - `PaymentReminderSentDate` string, date-time, nullable - `Number` integer - `BillingInvoiceStatus` 1 | 2 | 3 | 4 | 5 | 6 | 7: `1` - Unpaid, `2` - Paid, `3` - Partial, `4` - Uncollected, `5` - Refunded, `6` - Uncollectible, `7` - Processing - `Subscription` Subscription (recursive) - `Amount` number - `AmountOutstanding` number - `InvoiceLineItems` InvoiceLineItem[], nullable - … - `IsUserGenerated` boolean - `StripeTaxCalculationId` string, nullable - `StripeTaxBehavior` string, nullable - `AmountCredit` number - `AmountDiscount` number - `AmountPaid` number - `AmountRefunded` number - `AmountSubtotal` number - `AmountTax` number - `AmountTaxRefunded` number - `IsTaxable` boolean - `HasPaymentGatewayTransactions` boolean - `StripePaymentTransactionIds` string, nullable - `StripeRefundTransactionIds` string, nullable - `StripeTaxRefundTransactionIds` string, nullable - `Rate` number, nullable - `PrimaryStripeSubscription` StripeSubscription - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `ApplicationFeePercent` number, nullable - `CancelAt` string, date-time, nullable - `CancelAtPeriodEnd` boolean - `StripeSubscriptionCancellation` StripeSubscriptionCancellation - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `Comment` string, nullable - `Feedback` string, nullable - `Reason` string, nullable - `Account` Account (recursive) - `CancelationReason` string, nullable - `LastProduct` StripeProduct - … - `SubmittedDateTime` string, date-time - `SubscribingStartDate` string, date-time - `Currency` string, nullable - `EndedAt` string, date-time, nullable - `PauseCollection_Behavior` string, nullable - `PauseCollection_ResumesAt` string, date-time, nullable - `StartDate` string, date-time - `Status` string, nullable - `TrialEnd` string, date-time, nullable - `StripeDiscounts` StripeDiscount[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `Account` Account (recursive) - `CheckoutSessionId` string, nullable - `End` string, date-time, nullable - `InvoiceId` string, nullable - `InvoiceItemId` string, nullable - `IsDeleted` boolean - `Start` string, date-time - `StripeCoupon` StripeCoupon - … - `StripePromotionCode` StripePromotionCode - … - `SubscriptionId` string, nullable - `SubscriptionItemId` string, nullable - `CouponId` string, nullable - `CustomerId` string, nullable - `StripeInvoice` StripeInvoice - … - `StripeSubscription` StripeSubscription (recursive) - `PromotionCodeId` string, nullable - `StripeSubscriptionItems` StripeSubscriptionItem[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CurrentPeriodStart` string, date-time - `CurrentPeriodEnd` string, date-time - `StripeSubscription` StripeSubscription (recursive) - `StripeDiscounts` StripeDiscount[], nullable - … - `StripePrice` StripePrice - … - `Quantity` integer - `PriceId` string, nullable - `StripeSubscriptionSchedules` StripeSubscriptionSchedule[], nullable - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CompletedAt` string, date-time, nullable - `CurrentPhase_EndDate` string, date-time, nullable - `CurrentPhase_StartDate` string, date-time, nullable - `EndBehavior` string, nullable - `StripeSubscriptionSchedulePhases` StripeSubscriptionSchedulePhase[], nullable - … - `ReleasedAt` string, date-time, nullable - `Status` string, nullable - `StripeSubscription` StripeSubscription (recursive) - `SubscriptionId` string, nullable - `ReleasedSubscriptionId` string, nullable - `Account` Account (recursive) - `AccountUid` string, nullable - `BillingCycleAnchor` string, date-time, nullable - `CollectionMethod` string, nullable - `CustomerId` string, nullable - `DaysUntilDue` integer, nullable - `ScheduleId` string, nullable - `StripeDiscountIds` string[], nullable - `StripePriceIds` string, nullable - `TrialPeriodDays` integer - `CurrentStripeSubscriptionSchedule` StripeSubscriptionSchedule - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `SchemaLessData` object, nullable - `StripeId` string, nullable - `IsLivemode` boolean - `CompletedAt` string, date-time, nullable - `CurrentPhase_EndDate` string, date-time, nullable - `CurrentPhase_StartDate` string, date-time, nullable - `EndBehavior` string, nullable - `StripeSubscriptionSchedulePhases` StripeSubscriptionSchedulePhase[], nullable - … - `ReleasedAt` string, date-time, nullable - `Status` string, nullable - `StripeSubscription` StripeSubscription (recursive) - `SubscriptionId` string, nullable - `ReleasedSubscriptionId` string, nullable - `RecaptchaToken` string, nullable - `StripeCheckoutMetadata` object, nullable - `StripeNextInvoiceSequence` integer, nullable - `StripePrice` string[], nullable - `StripePriceIds` string, nullable - `StripePromotionCode` string, nullable - `TaxId` string, nullable - `TaxIdIsInvalid` boolean - `TaxIdType` string, nullable - `WebflowSlug` string, nullable - `AccountUids` string, nullable - `EmailListPerson` EmailListPerson[], nullable - `FullName` string, nullable - `HasLoggedIn` boolean - `OAuthIntegrationStatus` 0 | 1: `0` - None, `1` - Gmail - `OptInToEmailList` boolean - `Password` string, nullable - `RecaptchaToken` string, nullable - `UserAgentPlatformBrowser` string, nullable - `HasUnsubscribed` boolean - `DiscordUser` DiscordUser - `Uid` string, nullable - `_objectType` string, nullable - `Created` string, date-time, required - `Updated` string, date-time, required - `ActivityEventData` unknown - `DiscordUserId` string, nullable - `DiscordEmail` string, nullable - `DiscordUsername` string, nullable - `DiscordOAuthRefreshToken` string, nullable - `IsConnectedToDiscord` boolean - `EmailListSubscriberStatus` 1 | 2 | 3 | 4: `1` - Subscribed, `2` - Unsubscribed, `3` - Cleaned, `4` - Confirmed - `SubscribedDate` string, date-time - `ConfirmedDate` string, date-time, nullable - `ConfirmationNotes` string, nullable - `UnsubscribedDate` string, date-time, nullable - `CleanedDate` string, date-time, nullable - `WelcomeEmailDeliverDateTime` string, date-time, nullable - `WelcomeEmailOpenDateTime` string, date-time, nullable - `UnsubscribeReason` string, nullable - `UnsubscribeReasonOther` string, nullable - `RecaptchaToken` string, nullable - `RecaptchaSiteKey` string, nullable - `SendWelcomeEmail` boolean - `Source` string, nullable - `FieldConfigurationDataJSON` string, nullable - `CountSubscriptionsActive` integer - `CountSubscriptionsBounce` integer - `CountSubscriptionsIssues` integer - `CountSubscriptionsNotConfirmed` integer - `CountSubscriptionsSpam` integer - `CountSubscriptionsUnsubscribed` integer ## Other responses - `400`: Invalid Uid format - `401`: Unauthorized - `404`: EmailList not found --- [API](https://skmtc.dev/outseta/apis/outseta-api.md) · [All operations](https://skmtc.dev/outseta/apis/outseta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/outseta/apis/outseta-api/revisions/c362823af82d?raw)