CRM

Register a new account.

This is the same endpoint the sign up embed uses to create accounts. At a minimum you must pass one Primary Contact with an Email address and one Subscription record with a reference to a Plan. Other fields (e.g. Account Name, Billing Address, Payment Information, etc.) can be passed as desired. A confirmation email will be sent to the user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN page.

post/api/v1/crm/registrations

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/crm/registrations
Auth: none declared

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

SchemaLessDataobject nullable

StripeIdstring nullable

IsLivemodeboolean

Namestring required

ClientIdentifierstring nullable

Currencystring nullable

InvoiceNotesstring nullable

IsDemoboolean

AccountStage2 | 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

StripeDefaultPaymentMethodIdstring nullable

LastLoginDateTimestring date-time nullable

AccountSpecificPageUrl1string nullable

AccountSpecificPageUrl2string nullable

AccountSpecificPageUrl3string nullable

AccountSpecificPageUrl4string nullable

AccountSpecificPageUrl5string nullable

AccountSpecificPageUrl6string nullable

AccountSpecificPageUrl7string nullable

AccountSpecificPageUrl8string nullable

AccountSpecificPageUrl9string nullable

AccountSpecificPageUrl10string nullable

RewardFulReferralIdstring nullable

ToltReferralIdstring nullable

TaxStatusstring nullable

AccountStageLabelstring nullable

CurrentStripeProductsstring nullable

DomainNamestring nullable

TenantBillingSystem1 | 2

1 - Outseta, 2 - Stripe

HasLoggedInboolean

LifetimeRevenuenumber

NextStripeInvoiceDatestring date-time nullable

Noncestring nullable

RecaptchaTokenstring nullable

StripeCheckoutMetadataobject nullable

StripeNextInvoiceSequenceinteger nullable

StripePricestring[] nullable

StripePriceIdsstring nullable

StripePromotionCodestring nullable

TaxIdstring nullable

TaxIdIsInvalidboolean

TaxIdTypestring nullable

WebflowSlugstring nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SchemaLessData": {},
  "StripeId": "string",
  "IsLivemode": false,
  "Name": "string",
  "ClientIdentifier": "string",
  "Currency": "string",
  "InvoiceNotes": "string",
  "IsDemo": false,
  "BillingAddress": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "AddressLine1": "string",
    "AddressLine2": "string",
    "AddressLine3": "string",
    "City": "string",
    "State": "string",
    "PostalCode": "string",
    "Country": "string",
    "GeoLocation": "string"
  },
  "MailingAddress": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "AddressLine1": "string",
    "AddressLine2": "string",
    "AddressLine3": "string",
    "City": "string",
    "State": "string",
    "PostalCode": "string",
    "Country": "string",
    "GeoLocation": "string"
  },
  "AccountStage": 2,
  "PaymentInformation": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Account": {},
    "CustomerToken": "string",
    "LastFourDigits": "string",
    "LatestFailureDateTime": "string",
    "LatestFailureDescription": "string",
    "LatestSuccessDateTime": "string",
    "NumberOfFailures": 0,
    "PaymentClientSecret": "string",
    "PaymentMethodType": "string",
    "PaymentToken": "string",
    "BankName": "string",
    "BankAccountType": "string",
    "BankAccountHolderType": "string",
    "NameOnCard": "string",
    "CardType": "string",
    "ExpirationMonth": "string",
    "ExpirationYear": "string",
    "Mode": "string",
    "OneTimeToken": "string",
    "RecaptchaToken": "string",
    "SetupIntent": "string"
  },
  "PersonAccount": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Person": {},
      "Account": {},
      "IsPrimary": false,
      "ReceiveInvoices": false,
      "Role": 1
    }
  ],
  "StripeDefaultPaymentMethodId": "string",
  "StripeInvoices": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "AmountDue": 0,
      "AmountPaid": 0,
      "AmountShipping": 0,
      "AttemptCount": 0,
      "Attempted": false,
      "Currency": "string",
      "Description": "string",
      "FinalizedAt": "string",
      "HostedInvoiceUrl": "string",
      "InvoicePdf": "string",
      "NextPaymentAttempt": "string",
      "Number": "string",
      "PeriodEnd": "string",
      "PeriodStart": "string",
      "Status": "string",
      "StripeDiscounts": [],
      "StripeInvoiceDiscountAmounts": [],
      "StripeInvoiceLineItems": [],
      "StripeInvoicePayments": [],
      "SubTotal": 0,
      "SubTotalExcludingTax": 0,
      "SubscriptionId": "string",
      "Tax": 0,
      "Total": 0,
      "TotalExcludingTax": 0,
      "Account": {},
      "IsImported": false,
      "IsRefunded": false,
      "CurrencyAmountCreditedPostPayment": 0,
      "CurrencyAmountCreditedPrePayment": 0,
      "CurrencyAmountDue": 0,
      "CurrencyAmountPaid": 0,
      "CurrencySymbol": "string",
      "CurrencyTotal": 0,
      "CurrencyTotalExcludingTax": 0,
      "CurrencySubTotal": 0,
      "CurrencySubTotalExcludingTax": 0,
      "CurrencyTax": 0,
      "DaysUntilDue": 0,
      "CustomerId": "string",
      "PaymentStatus": "string",
      "StripeCreditNotes": [],
      "StripePaymentMethodId": "string"
    }
  ],
  "StripePaymentMethods": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "Account": {},
      "Card_Brand": "string",
      "Card_ExpMonth": 0,
      "Card_ExpYear": 0,
      "Card_Wallet_Type": "string",
      "BankName": "string",
      "Last4": "string",
      "Type": "string",
      "Label": "string"
    }
  ],
  "StripeSubscriptions": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "ApplicationFeePercent": 0,
      "CancelAt": "string",
      "CancelAtPeriodEnd": false,
      "StripeSubscriptionCancellation": {},
      "Currency": "string",
      "EndedAt": "string",
      "PauseCollection_Behavior": "string",
      "PauseCollection_ResumesAt": "string",
      "StartDate": "string",
      "Status": "string",
      "TrialEnd": "string",
      "StripeDiscounts": [],
      "StripeSubscriptionItems": [],
      "StripeSubscriptionSchedules": [],
      "Account": {},
      "AccountUid": "string",
      "BillingCycleAnchor": "string",
      "CollectionMethod": "string",
      "CustomerId": "string",
      "DaysUntilDue": 0,
      "ScheduleId": "string",
      "StripeDiscountIds": [],
      "StripePriceIds": "string",
      "TrialPeriodDays": 0,
      "CurrentStripeSubscriptionSchedule": {}
    }
  ],
  "Subscriptions": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "BillingRenewalTerm": 1,
      "Account": {},
      "Plan": {},
      "Quantity": 0,
      "StartDate": "string",
      "EndDate": "string",
      "ExpirationDate": "string",
      "RenewalDate": "string",
      "NewRequiredQuantity": 0,
      "IsPlanUpgradeRequired": false,
      "PlanUpgradeRequiredMessage": "string",
      "SubscriptionAddOns": [],
      "DiscountCouponSubscriptions": [],
      "DiscountCode": "string",
      "DiscountCouponExpirationDate": "string",
      "LatestInvoice": {},
      "Rate": 0
    }
  ],
  "Deals": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "Name": "string",
      "Amount": 0,
      "DueDate": "string",
      "AssignedToPersonClientIdentifier": "string",
      "Weight": 0,
      "DealPipelineStage": {},
      "Account": {},
      "DealPeople": [],
      "Contacts": "string",
      "AccountId": 0,
      "Owner": {},
      "PipelineUid": "string"
    }
  ],
  "LastLoginDateTime": "string",
  "AccountSpecificPageUrl1": "string",
  "AccountSpecificPageUrl2": "string",
  "AccountSpecificPageUrl3": "string",
  "AccountSpecificPageUrl4": "string",
  "AccountSpecificPageUrl5": "string",
  "AccountSpecificPageUrl6": "string",
  "AccountSpecificPageUrl7": "string",
  "AccountSpecificPageUrl8": "string",
  "AccountSpecificPageUrl9": "string",
  "AccountSpecificPageUrl10": "string",
  "RewardFulReferralId": "string",
  "ToltReferralId": "string",
  "TaxIds": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "Account": {},
      "TaxId": "string",
      "TaxIdType": "string",
      "IsInvalid": false
    }
  ],
  "TaxStatus": "string",
  "AccountStageLabel": "string",
  "CurrentStripeProducts": "string",
  "CurrentStripeProductInstances": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "StripeId": "string",
      "IsLivemode": false,
      "Name": "string",
      "DefaultPriceId": "string",
      "Description": "string",
      "IsActive": false,
      "TaxCodeId": "string",
      "UnitLabel": "string",
      "ContentGroups": [],
      "StripePrices": [],
      "AccountRegistrationMode": 1,
      "ExpiresAfterMonths": 0,
      "ExpirationDate": "string",
      "IsPerUser": false,
      "IsQuantityEditable": false,
      "MaximumPeople": 0,
      "MigratedAddOnUid": "string",
      "MigratedPlanUid": "string",
      "MinimumQuantity": 0,
      "PostLoginPath": "string",
      "PostPurchaseUrl": "string",
      "RequirePaymentInformation": false,
      "StripeProductCrossSells": [],
      "TrialPeriodDays": 0,
      "TrialUntilDate": "string",
      "CanDelete": false,
      "NumberOfPurchases": 0,
      "NumberOfSubscriptions": 0,
      "Quantity": 0,
      "StripeProductFamily": {}
    }
  ],
  "CurrentSubscription": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "BillingRenewalTerm": 1,
    "Account": {},
    "Plan": {},
    "Quantity": 0,
    "StartDate": "string",
    "EndDate": "string",
    "ExpirationDate": "string",
    "RenewalDate": "string",
    "NewRequiredQuantity": 0,
    "IsPlanUpgradeRequired": false,
    "PlanUpgradeRequiredMessage": "string",
    "SubscriptionAddOns": [],
    "DiscountCouponSubscriptions": [],
    "DiscountCode": "string",
    "DiscountCouponExpirationDate": "string",
    "LatestInvoice": {},
    "Rate": 0
  },
  "DomainName": "string",
  "TenantBillingSystem": 1,
  "HasLoggedIn": false,
  "LatestSubscription": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "BillingRenewalTerm": 1,
    "Account": {},
    "Plan": {},
    "Quantity": 0,
    "StartDate": "string",
    "EndDate": "string",
    "ExpirationDate": "string",
    "RenewalDate": "string",
    "NewRequiredQuantity": 0,
    "IsPlanUpgradeRequired": false,
    "PlanUpgradeRequiredMessage": "string",
    "SubscriptionAddOns": [],
    "DiscountCouponSubscriptions": [],
    "DiscountCode": "string",
    "DiscountCouponExpirationDate": "string",
    "LatestInvoice": {},
    "Rate": 0
  },
  "LifetimeRevenue": 0,
  "NextStripeInvoiceDate": "string",
  "Nonce": "string",
  "PrimaryContact": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "PasswordLastUpdated": "string",
    "PasswordMustChange": false,
    "PhoneMobile": "string",
    "PhoneWork": "string",
    "ProfileImageS3Url": "string",
    "Title": "string",
    "Timezone": "string",
    "Language": "string",
    "IPAddress": "string",
    "Referer": "string",
    "UserAgent": "string",
    "LastLoginDateTime": "string",
    "OAuthGoogleProfileId": "string",
    "PersonAccount": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "PrimarySubscription": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "BillingRenewalTerm": 1,
    "Account": {},
    "Plan": {},
    "Quantity": 0,
    "StartDate": "string",
    "EndDate": "string",
    "ExpirationDate": "string",
    "RenewalDate": "string",
    "NewRequiredQuantity": 0,
    "IsPlanUpgradeRequired": false,
    "PlanUpgradeRequiredMessage": "string",
    "SubscriptionAddOns": [],
    "DiscountCouponSubscriptions": [],
    "DiscountCode": "string",
    "DiscountCouponExpirationDate": "string",
    "LatestInvoice": {},
    "Rate": 0
  },
  "PrimaryStripeSubscription": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "StripeId": "string",
    "IsLivemode": false,
    "ApplicationFeePercent": 0,
    "CancelAt": "string",
    "CancelAtPeriodEnd": false,
    "StripeSubscriptionCancellation": {},
    "Currency": "string",
    "EndedAt": "string",
    "PauseCollection_Behavior": "string",
    "PauseCollection_ResumesAt": "string",
    "StartDate": "string",
    "Status": "string",
    "TrialEnd": "string",
    "StripeDiscounts": [],
    "StripeSubscriptionItems": [],
    "StripeSubscriptionSchedules": [],
    "Account": {},
    "AccountUid": "string",
    "BillingCycleAnchor": "string",
    "CollectionMethod": "string",
    "CustomerId": "string",
    "DaysUntilDue": 0,
    "ScheduleId": "string",
    "StripeDiscountIds": [],
    "StripePriceIds": "string",
    "TrialPeriodDays": 0,
    "CurrentStripeSubscriptionSchedule": {}
  },
  "RecaptchaToken": "string",
  "StripeCheckoutMetadata": {},
  "StripeNextInvoiceSequence": 0,
  "StripePrice": [
    "string"
  ],
  "StripePriceIds": "string",
  "StripePromotionCode": "string",
  "TaxId": "string",
  "TaxIdIsInvalid": false,
  "TaxIdType": "string",
  "WebflowSlug": "string"
}

Response