Organization
Representation of an organization
Properties
Section titled “Properties”| Property | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | |
name | string | No | Nullable. |
purchasedAnalystSupport | boolean | No | Read-only response field. |
affiliate_guid | string (uuid) | No | Nullable. |
affiliate | AffiliateInfo | No | |
credits_available | integer (int32) | No | |
credits_used | integer (int32) | No | |
stripe_customerId | string | No | Nullable. |
socialMediaScraperYears | integer (int32) | No | |
planType | PlanType | No | |
paymentMethod | PaymentMethod | No | |
isSubscriptionActive | boolean | No | |
stripeSubscriptionId | string | No | Nullable. |
stripePlanId | string | No | Nullable. |
stripePricingId | string | No | Nullable. |
numberOfContinuousScreeningSubjectsEnabled | integer (int64) | No | The number of subjects for which continuous screening is enabled |
piplCreditsAvailable | integer (int32) | No | |
piplCreditsUsed | integer (int32) | No | |
alternateDisclaimerText | string | No | Text to use as an alternate disclaimer page Nullable. |
data_retention_years | integer (int32) | No | Number of years used for data retention |
data_retention_period | DataRetentionPeriod | No | |
instructions | string | No | Gets or sets the instructions for the organization Nullable. |
pricingModel | PricingModel | No | |
isReseller | boolean | No | Gets or sets whether the organization is a reseller. This flag distinguishes resellers from standard organizations in the system. |
allowNegativeCredits | boolean | No | When true, the organization is permitted to carry a negative credit balance. Charging flows will not reject requests when credits are at or below zero. |
Use only the documented fields.