> ## Documentation Index > Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get subscription information > Get the subscription information for the organization. ## OpenAPI ````yaml /openapi.json get /billing/subscription/ openapi: 3.1.0 info: contact: email: support@getoneprofile.ai name: Oneprofile Support description: >- REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started. termsOfService: https://www.getoneprofile.ai/terms title: API Reference | Oneprofile version: '0.0' servers: - url: https://api.getoneprofile.ai security: [] tags: - description: Sender profiles, connected mailboxes, tags, and the Google connect flow. name: senders - description: The workspace do-not-contact list, enforced before every send. name: suppression - description: 'Sequence authoring: the graph, the table-backed audience, previews.' name: sequences - description: >- The LinkedIn channel: connecting an account to a sender, its safety limits and history, and the protocol the browser extension speaks. name: linkedin - description: 'The unified outreach inbox: threads, replies, labels, events.' name: inbox - description: 'The AI reply layer: workspace settings, drafts, and approval.' name: inbox-ai - description: Notification rules, per-user preferences, and the Slack connection. name: notifications - description: Endpoints for seeing all available integration types. name: integration-types - description: Endpoints for creating and managing integrations. name: integrations - description: Endpoints for the generic OAuth install/claim app-listings engine. name: app-listings - description: Endpoints for creating and managing API keys. name: apikey - description: Endpoints for managing billing and subscription information. name: billing - description: Endpoints for creating and managing tables. name: tables - description: Endpoints for table columns, formula previews, and on-demand column runs. name: table-columns - description: Endpoints for table rows and manual cell edits. name: table-rows - description: Endpoints for observing and cancelling table recompute runs. name: table-runs - description: >- Endpoints for org-shared per-column display preferences: hidden, pinned, width, and colour tint. name: table-ui-prefs - description: >- Endpoints for the org-shared names given to the column tint palette: what this organisation calls each colour. Org-level, not per-table. name: table-column-color-labels - description: >- Endpoints for the enrichment action catalog, model list, presets, draft generation, and saved agents. name: table-enrichments - description: >- Endpoints for teaching a saved agent from example rows: training sessions, per-row feedback, and the proposed prompt to approve. name: agent-training - description: >- The durable audit trail of a table's enrichment actions: configured, edited, run, cancelled, and settled cost. name: table-enrichment-audit-logs - description: Endpoints for saving and applying column templates. name: table-templates - description: Server-sent change feed for a table's grid. name: table-events - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.' name: table-views - description: >- The per-table AI Assistant: named conversations, the column suggestions a build turn produces, and the questions an analyze turn answers. name: table-assistant - description: >- Endpoints for PER-USER table preferences: favourites and recently opened. Unlike the rest of the table surface these are personal, so two members of one organisation legitimately see different answers. name: table-user-prefs - description: >- Endpoints for building a table from an uploaded CSV: upload and preview the inferred columns, commit the reviewed mapping, then poll the row load. name: table-imports - description: Endpoint for downloading a table's rows as CSV. name: table-export - description: >- Endpoints for the integration a table imports from: attach and preview it, promote imported fields into columns, and run the import on demand. name: table-sources - description: >- Endpoints for a table's recurring import cadence: set it, pause it, and read the next fire times. name: table-schedules - description: >- Endpoints for pushing a table's rows out to a connected integration: list writable destinations, derive their write capabilities, and map export columns. name: table-writeback - description: >- Endpoints backing a lookup column's setup: the connections whose records a column could read, and the identity fields one record type can be looked up by. name: table-integration-lookup - description: >- Endpoints for sourcing leads from the lead database: count and preview matches, land them in a table, and keep saved searches. name: find-leads - description: >- Endpoints for discovering a domain's subdomains from public certificate logs and landing the results in a table. name: find-subdomains - description: Endpoints for the credit balance meter and usage reporting. name: credits - description: >- Endpoints for the workspace referral program: the shareable link, the friends who joined through it, and claiming a code after signup. name: referral - description: >- Endpoints for the design partner program's customer surface: whether this workspace is a design partner, the badges its feedback has earned, and sending and reading that feedback. name: design-partner - description: >- Endpoints for the org-level AI business context — company description, ideal customer profile, buyer personas and interest signals — plus domain-based generation. name: ai-context paths: /billing/subscription/: get: tags: - billing summary: Get subscription information description: Get the subscription information for the organization. operationId: get_subscription responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRead' description: Successful Response '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' description: Invalid request made to the API. '500': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Internal server error. '502': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Bad gateway error. '503': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Service unavailable. security: - HTTPBearer: [] - APIKeyHeader: [] components: schemas: SubscriptionRead: description: Response schema for subscription information. properties: billing_email: anyOf: - format: email type: string - type: 'null' description: 'The billing email address for invoices and billing alerts. ' title: Billing Email billing_interval: anyOf: - enum: - month - year type: string - type: 'null' description: The billing interval of the subscription. None for free plans. title: Billing Interval cancel_at: anyOf: - format: date-time type: string - type: 'null' description: >- The date when the subscription is scheduled to be canceled. If set, the subscription will be canceled at this time. None if the subscription is not scheduled for cancellation. title: Cancel At credit_quantity: description: The monthly credit allowance the subscription's own price grants. title: Credit Quantity type: integer credit_tier_key: anyOf: - type: string - type: 'null' description: >- The selected credit volume (e.g. 'team_tier_20k'). None for free plans. title: Credit Tier Key current_period_end: anyOf: - format: date-time type: string - type: 'null' description: >- The end of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance. title: Current Period End current_period_start: anyOf: - format: date-time type: string - type: 'null' description: >- The start of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance. title: Current Period Start current_price_decimal: anyOf: - type: string - type: 'null' description: >- What the subscription actually costs per `billing_interval` unit, in cents, read off its own Stripe price. None for free plans. Prefer this over recomputing from the catalog: it stays right for a grandfathered price or a volume the catalog has since retired. title: Current Price Decimal data_retention: description: Data retention period. format: duration title: Data Retention type: string included_credits: description: Credits granted each period (the period allowance). title: Included Credits type: integer is_product_limited: description: > Whether the product is currently limited due to usage or payment issues. When True, the organization cannot perform billable actions. This happens in two scenarios: 1. The credit balance is exhausted. 2. The subscription status is UNPAID (payment failed or cancelled). title: Is Product Limited type: boolean max_integrations: description: Maximum number of integrations allowed. 0 means unlimited. title: Max Integrations type: integer max_rows_per_table: description: Maximum number of rows per table. 0 means unlimited. title: Max Rows Per Table type: integer max_tables: description: Maximum number of tables allowed. 0 means unlimited. title: Max Tables type: integer payment_method: anyOf: - $ref: '#/components/schemas/PaymentMethodReadSchema' - type: 'null' description: The default payment card summary. None when no card is on file. product_name: description: The product name for the subscription. title: Product Name type: string product_type: $ref: '#/components/schemas/ProductTier' description: The product name for the subscription. seats: description: Number of seats included. 0 means unlimited. title: Seats type: integer status: $ref: '#/components/schemas/SubscriptionStatus' description: > The subscription status. - active: User has active product with no past due fees. - Product remains active with full functionality. - incomplete_payment: The first payment failed or is processing. - Product remains active with full functionality. - User action is required to activate. Otherwise the product will become UNPAID. - past_due: The subscription fees aren't paid. Stripe will retry to collect the payment. - Product remains active with full functionality. - No user action is needed yet. However a user can proactively solve the issue. - unpaid: The subscription fees aren't paid. Stripe will no longer try to collect the payment. - Product is not functional anymore. - Needs user action to activate. required: - product_name - product_type - status - current_period_start - current_period_end - billing_interval - credit_tier_key - current_price_decimal - credit_quantity - payment_method - billing_email - is_product_limited - max_integrations - included_credits - max_tables - max_rows_per_table - data_retention - seats title: SubscriptionRead type: object UnauthorizedResponse: properties: detail: description: The detail of why the request is unauthorized. title: Detail type: string required: - detail title: UnauthorizedResponse type: object ForbiddenResponse: properties: detail: description: The detail of why the request is forbidden. title: Detail type: string required: - detail title: ForbiddenResponse type: object UnprocessableEntityResponse: properties: detail: description: >- The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message. title: Detail type: string issues: description: >- The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message. items: $ref: '#/components/schemas/UnprocessableEntityIssue' title: Issues type: array required: - detail - issues title: UnprocessableEntityResponse type: object ServerErrorResponse: properties: detail: description: The detail of why the server returned an error. title: Detail type: string required: - detail title: ServerErrorResponse type: object PaymentMethodReadSchema: description: Displayable summary of the organization's default payment card. properties: brand: description: The card brand, e.g. 'visa'. title: Brand type: string exp_month: description: The card expiry month (1-12). title: Exp Month type: integer exp_year: description: The four-digit card expiry year. title: Exp Year type: integer last4: description: The last four digits of the card number. title: Last4 type: string required: - brand - last4 - exp_month - exp_year title: PaymentMethodReadSchema type: object ProductTier: description: >- The tier of a product in Stripe. Declared cheapest-first. Free and Enterprise never touch Stripe: Free is free, Enterprise is sales-led and has no self-serve price. A subscription's tier is recovered from its price's ``product_tier`` metadata, never by reverse-parsing a Stripe product name: a product is named for the plan AND the credit volume it sells ("Team Plan (10,000 credits)"), so the name has not round-tripped to a tier since prices collapsed to one per plan+volume. enum: - free_plan - team_plan - pro_plan - enterprise_plan title: ProductTier type: string SubscriptionStatus: description: >- The status of a subscription for an organization. Active is the good state for all types of products. All other states are transitional states. When a subscription is cancelled, it becomes Free plan. We treat cancelled Stripe subscriptions as non-existent. Customer won't see any cancelled subscriptions on billing portal. There is a long transition from: Active -> Past Due -> Unpaid -> Free enum: - active - incomplete_payment - past_due - unpaid title: SubscriptionStatus type: string UnprocessableEntityIssue: properties: input: anyOf: - type: string - type: integer - type: number - type: boolean - items: {} type: array - additionalProperties: true type: object description: The user's input that caused the error. title: Input loc: description: >- The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present. items: type: string title: Loc type: array msg: description: The message of the error. The error message to show to the user. title: Msg type: string type: description: >- The type of the error. Useful for frontend code to handle different types of errors. title: Type type: string required: - loc - msg - type - input title: UnprocessableEntityIssue type: object securitySchemes: HTTPBearer: scheme: bearer type: http APIKeyHeader: in: header name: X-API-Key type: apiKey ````