> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # Get comprehensive partner billing overview > Retrieves the partner's credits (`operationalCredits`), the partner's contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it. `operationalCredits` is the one account a partner has for its credits: the account of the person who administers it. It holds `balance` (the same balance `getPartnerCreditBalance` reads), `reservedBalance`, `availableBalance` (what a new operation can use) and `recentTransactions` (the ten newest entries of the ledger `getPartnerCreditTransactions` lists). A partner with no administrator has no account, and reads 0 and an empty list. ## OpenAPI ````yaml /openapi/widgetic-api-public.json get /partners/{partnerId}/billing-overview openapi: 3.0.0 info: title: Widgetic API Gateway version: 1.0.0 description: API documentation for the Widgetic API Gateway license: name: Widgetic Integration License url: https://docs.widgetic.com/resources/license servers: - url: https://api.widgetic.com/v1 description: Production server variables: env: default: production description: Environment apiUrl: default: https://api.widgetic.com description: API URL apiVersion: default: /v1 description: API Version path prefix security: [] tags: [] paths: /partners/{partnerId}/billing-overview: get: tags: - Partners summary: Get comprehensive partner billing overview description: > Retrieves the partner's credits (`operationalCredits`), the partner's contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it. `operationalCredits` is the one account a partner has for its credits: the account of the person who administers it. It holds `balance` (the same balance `getPartnerCreditBalance` reads), `reservedBalance`, `availableBalance` (what a new operation can use) and `recentTransactions` (the ten newest entries of the ledger `getPartnerCreditTransactions` lists). A partner with no administrator has no account, and reads 0 and an empty list. operationId: getPartnerBillingOverview parameters: - in: path name: partnerId required: true schema: type: string format: uuid description: Partner ID responses: '200': description: Partner billing overview retrieved successfully content: application/json: schema: type: object properties: success: type: boolean data: $ref: '#/components/schemas/PartnerBillingOverview' meta: $ref: '#/components/schemas/ResponseMeta' required: - success - data security: - apiKeyAuth: [] components: schemas: PartnerBillingOverview: type: object required: - partner - operationalCredits - billingIntegration description: The partner's credits, contract terms and billing status in one answer. properties: partner: type: object required: - id - name - isActive - tier properties: id: type: string format: uuid name: type: string isActive: type: boolean tier: type: string enum: - partner - standard description: '`partner` once a contract has been recorded for the partner' operationalCredits: type: object required: - balance - reservedBalance - availableBalance - recentTransactions properties: balance: type: number description: Credits the account holds reservedBalance: type: number description: >- Credits committed to an operation that is still running. Not spendable. availableBalance: type: number description: >- What a new operation can use (`balance` minus `reservedBalance`, never below 0) recentTransactions: type: array description: The ten newest ledger entries, newest first items: $ref: '#/components/schemas/AccountCreditTransaction' description: > The partner's credits: what the account that pays for the partner (its administrator's) holds, and the newest entries of that account's ledger. A partner with no administrator reads 0 and an empty list. partnerCustomization: nullable: true description: The partner's contract; null while none has been recorded allOf: - $ref: '#/components/schemas/PartnerCustomization' billingIntegration: type: object required: - hasPartnerPlan - usesCustomPricing - billingCycle - contractActive properties: hasPartnerPlan: type: boolean usesCustomPricing: type: boolean description: True when a price was agreed on the contract billingCycle: type: string enum: - monthly - quarterly - annual contractActive: type: boolean example: partner: {} operationalCredits: {} partnerCustomization: null billingIntegration: {} ResponseMeta: type: object description: >- Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat. additionalProperties: true properties: page: type: integer description: The page that was read, counting from 1. example: 1 size: type: integer description: How many items one page holds. example: 20 total: type: integer description: How many items the whole list has. example: 135 limit: type: integer description: The same as `size`. example: 20 offset: type: integer description: How many items come before this page. example: 0 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false nextCursor: type: string nullable: true description: >- Pass this as `cursor` to read the next page of a list that is read by cursor. `null` on the last page. warnings: type: array items: type: string description: >- Things the call did not do, though it succeeded (for example a table that could not be created just now). AccountCreditTransaction: type: object description: One entry of an account's credit ledger. properties: id: type: string format: uuid transactionType: type: string nullable: true description: > What the entry did to the balance. `debit` is credits spent (this is how consumption shows), `credit` and `subscription` are credits added, `refund` returns credits that were spent, `reserve` and `release` move credits in and out of the reserved amount, and `adjustment`, `expiration`, `transfer_out` and `transfer_in` are the remaining ways a balance changes. The list can grow, so treat an unknown type as an entry you do not need to interpret. amount: type: number description: >- Always positive. The `transactionType` says whether the credits were added or taken. balanceAfter: type: number nullable: true description: The balance once this entry was applied description: type: string nullable: true referenceId: type: string nullable: true description: >- The event the entry belongs to. An entry is recorded once per reference. createdAt: type: string format: date-time example: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 transactionType: Example transactionType amount: 42 balanceAfter: 42 description: Example description referenceId: Example referenceId createdAt: '2026-01-15T09:30:00.000Z' PartnerCustomization: type: object description: Partner contract customization for a partner properties: id: type: string format: uuid description: Unique identifier for the customization partnerId: type: string format: uuid description: ID of the partner this customization belongs to customPrice: type: number description: Custom monthly price override example: 299.99 customCredits: type: number description: >- Credits the partner receives each billing period (`billingCycle`). What a period costs is derived from it, see `periodTotalUsd` example: 5000 creditPriceUsd: type: number nullable: true description: >- What the partner pays for one credit, in dollars (up to four decimals). Null means the list price example: 0.085 effectiveCreditPriceUsd: type: number description: >- What one credit costs the partner, in dollars. `creditPriceUsd` when the contract names one, the list price otherwise example: 0.085 periodTotalUsd: type: number nullable: true description: >- What one billing period costs, in dollars before tax. `customCredits` times `effectiveCreditPriceUsd`; null while the contract names no credits example: 425 additionalFeatures: type: array items: type: string description: Additional features beyond base partner plan example: - Advanced analytics - White-label branding billingCycle: type: string enum: - monthly - quarterly - annual description: Billing cycle for the customization example: annual minimumCommitmentMonths: type: number description: Minimum commitment period in months example: 12 supportSla: type: string description: Support SLA percentage example: 99.9% contractStartDate: type: string format: date description: Contract start date example: '2024-01-01' contractEndDate: type: string format: date description: Contract end date example: '2024-12-31' notes: type: string description: Admin notes about the customization example: Special pricing for strategic partner isActiveContract: type: boolean description: Whether the contract is currently active example: true createdAt: type: string format: date-time description: Creation timestamp updatedAt: type: string format: date-time description: Last update timestamp example: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 partnerId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 customPrice: 299.99 customCredits: 5000 creditPriceUsd: 0.085 effectiveCreditPriceUsd: 0.085 periodTotalUsd: 425 additionalFeatures: - Advanced analytics - White-label branding billingCycle: annual minimumCommitmentMonths: 12 supportSla: 99.9% contractStartDate: '2024-01-01' contractEndDate: '2024-12-31' notes: Special pricing for strategic partner isActiveContract: true createdAt: '2026-01-15T09:30:00.000Z' updatedAt: '2026-01-15T09:30:00.000Z' securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.