> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt > Use this file to discover all available pages before exploring further. # Get a customer's agent billing policy > One billing scope: the customer's default policy, or one agent's own when `agent` is passed. 404 when that scope has no policy of its own. ## OpenAPI ````yaml get /v1/ai/billing/customers/{customer_id}/policy openapi: 3.1.0 info: title: Hyperline API version: 0.0.0 servers: - url: https://api.hyperline.co - url: https://sandbox.api.hyperline.co security: [] paths: /v1/ai/billing/customers/{customer_id}/policy: get: tags: - AI > Billing summary: Get a customer's agent billing policy description: >- One billing scope: the customer's default policy, or one agent's own when `agent` is passed. 404 when that scope has no policy of its own. operationId: getAgentCustomerPolicy parameters: - schema: type: string required: true name: customer_id in: path - schema: type: string minLength: 1 maxLength: 128 description: >- Agent scope identifier. Null on scoped results denotes the customer's shared pool. example: support required: false description: >- Agent scope identifier. Null on scoped results denotes the customer's shared pool. name: agent in: query responses: '200': description: '' content: application/json: schema: type: object properties: id: type: string description: Unique Hyperline identifier for this resource. example: d18603dd-7285-4bf5-a45e-88d7de8f37c9 customer_id: type: string description: Hyperline customer identifier. example: cus_example agent_slug: type: - string - 'null' description: >- Agent scope identifier. Null is the customer's shared pool. example: support is_default: type: boolean description: Whether this is the default plan or shared customer scope. example: false mode: type: string enum: - wallet - credits - windows description: >- Billing mode. - wallet: Charges a monetary wallet. - credits: Consumes a credit balance. - windows: Meters weighted units against rolling allowances. example: wallet wallet_id: type: - string - 'null' description: >- Customer wallet identifier. Omit on wallet policy writes to provision or reuse the customer's wallet. example: wal_example credit_product_id: type: - string - 'null' description: >- Public credit product identifier whose balance this policy consumes. example: prd_credits markup_percent: type: string pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value. example: '20' overage_mode: type: string enum: - refuse - metered description: >- Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan. - refuse: Rejects the call that crosses the boundary without deducting usage. - metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup. example: metered overage_markup_percent: type: string pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id. example: '10' overage_rate_card_id: type: - string - 'null' description: >- Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup. example: airc_overage overage_rate_card_source: type: - string - 'null' enum: - policy - plan description: >- Source of the effective overage rate card. Null when no card is configured. - policy: Selected directly on the customer policy. - plan: Inherited from the attached plan. example: plan overage_wallet_id: type: - string - 'null' description: Wallet charged for overage. Null bills overage in arrears. example: wal_example floor: type: string pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Minimum available balance a spend check requires, in the policy's denomination. example: '0' credit_rates: type: - object - 'null' properties: llm: type: array items: type: object properties: provider: type: string minLength: 1 maxLength: 64 description: >- AI model provider, or the vendor of a custom cost item. This is not an integration connection. example: anthropic model: type: string minLength: 1 maxLength: 128 description: >- Model identifier, or custom item identifier. Null on wildcard pricing rows. example: claude-sonnet-5 credits_per_1m_input: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per million input tokens, as an exact decimal string. example: '1000' credits_per_1m_output: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per million output tokens, as an exact decimal string. example: '5000' credits_per_1m_cached_input: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per million cached input tokens, as an exact decimal string. example: '100' credits_per_1m_cache_write: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per million cache write tokens, as an exact decimal string. example: '1250' dimensions: type: array items: type: object properties: key: type: string pattern: ^[a-z0-9_.]{1,64}$ description: >- Dimension or allowance identifier used by usage payloads and meter results. example: cached_input_tokens rate: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Applied rate. Receipt lines may contain a human-readable rate expression. example: '3' per: type: string enum: - 1m - 1k - unit description: |- Quantity basis for the dimension rate. - 1m: Per million units. - 1k: Per thousand units. - unit: Per single unit. example: 1m required: - key - rate - per maxItems: 20 description: >- Additional billable dimensions; each key matches a usage_extra key and rates use the owning card's units or USD for cost-catalog dimensions. example: - key: cached_input_tokens rate: '0.3' per: 1m required: - credits_per_1m_input - credits_per_1m_output maxItems: 500 description: >- Token pricing rows, matched by provider and model specificity. example: [] items: type: array items: type: object properties: vendor: type: string minLength: 1 maxLength: 64 description: >- Vendor identifier matching the custom item usage payload. example: search item: type: string minLength: 1 maxLength: 128 description: Custom item name matching the usage payload. example: search credits_per_unit: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per item unit, as an exact decimal string. example: '10' dimensions: type: array items: type: object properties: key: type: string pattern: ^[a-z0-9_.]{1,64}$ description: >- Dimension or allowance identifier used by usage payloads and meter results. example: cached_input_tokens rate: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Applied rate. Receipt lines may contain a human-readable rate expression. example: '3' per: type: string enum: - 1m - 1k - unit description: |- Quantity basis for the dimension rate. - 1m: Per million units. - 1k: Per thousand units. - unit: Per single unit. example: 1m required: - key - rate - per maxItems: 20 description: >- Additional billable dimensions; each key matches a usage_extra key and rates use the owning card's units or USD for cost-catalog dimensions. example: - key: cached_input_tokens rate: '0.3' per: 1m required: - vendor - item - credits_per_unit maxItems: 500 description: Per-item pricing rows. example: [] fallback_credits_per_usd: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Credits charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced. example: '1000' description: >- Inline credit pricing. Mutually exclusive with rate_card_id. Omitted rates may be supplied by a plan or product default. example: fallback_credits_per_usd: '1000' window_rates: type: - object - 'null' properties: unit_rates: type: object properties: llm: type: array items: type: object properties: provider: type: string minLength: 1 maxLength: 64 description: >- AI model provider, or the vendor of a custom cost item. This is not an integration connection. example: anthropic model: type: string minLength: 1 maxLength: 128 description: >- Model identifier, or custom item identifier. Null on wildcard pricing rows. example: claude-sonnet-5 units_per_1m_input: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Units charged per million input tokens, as an exact decimal string. example: '1000' units_per_1m_output: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Units charged per million output tokens, as an exact decimal string. example: '5000' units_per_1m_cached_input: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Units charged per million cached input tokens, as an exact decimal string. example: '100' units_per_1m_cache_write: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Units charged per million cache write tokens, as an exact decimal string. example: '1250' dimensions: type: array items: type: object properties: key: type: string pattern: ^[a-z0-9_.]{1,64}$ description: >- Dimension or allowance identifier used by usage payloads and meter results. example: cached_input_tokens rate: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Applied rate. Receipt lines may contain a human-readable rate expression. example: '3' per: type: string enum: - 1m - 1k - unit description: |- Quantity basis for the dimension rate. - 1m: Per million units. - 1k: Per thousand units. - unit: Per single unit. example: 1m required: - key - rate - per maxItems: 20 description: >- Additional billable dimensions; each key matches a usage_extra key and rates use the owning card's units or USD for cost-catalog dimensions. example: - key: cached_input_tokens rate: '0.3' per: 1m required: - units_per_1m_input - units_per_1m_output maxItems: 500 description: >- Token pricing rows, matched by provider and model specificity. example: [] items: type: array items: type: object properties: vendor: type: string minLength: 1 maxLength: 64 description: >- Vendor identifier matching the custom item usage payload. example: search item: type: string minLength: 1 maxLength: 128 description: Custom item name matching the usage payload. example: search units_per_unit: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Units charged per item unit, as an exact decimal string. example: '10' dimensions: type: array items: type: object properties: key: type: string pattern: ^[a-z0-9_.]{1,64}$ description: >- Dimension or allowance identifier used by usage payloads and meter results. example: cached_input_tokens rate: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Applied rate. Receipt lines may contain a human-readable rate expression. example: '3' per: type: string enum: - 1m - 1k - unit description: |- Quantity basis for the dimension rate. - 1m: Per million units. - 1k: Per thousand units. - unit: Per single unit. example: 1m required: - key - rate - per maxItems: 20 description: >- Additional billable dimensions; each key matches a usage_extra key and rates use the owning card's units or USD for cost-catalog dimensions. example: - key: cached_input_tokens rate: '0.3' per: 1m required: - vendor - item - units_per_unit maxItems: 500 description: Per-item pricing rows. example: [] fallback_units_per_usd: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Allowance units charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced. example: '1000' description: >- Conversion from token and item usage to weighted allowance units. example: fallback_units_per_usd: '1000' windows: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 32 pattern: ^[a-z0-9][a-z0-9_-]*$ description: >- Dimension or allowance identifier used by usage payloads and meter results. example: cached_input_tokens duration_minutes: type: integer minimum: 1 maximum: 527040 description: >- Rolling allowance duration in whole minutes, from 1 through 527040. example: 1440 included_units: type: string maxLength: 40 pattern: ^\d+(\.\d+)?$ description: >- Weighted units included in one allowance window, as an exact decimal string. example: '10000' required: - key - duration_minutes - included_units minItems: 1 maxItems: 8 description: >- Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array. example: - key: daily duration_minutes: 1440 included_units: '10000' required: - unit_rates - windows description: >- Window definitions and optional inline unit rates. An attached plan may supply omitted definitions; rate_card_id may supply unit rates. example: unit_rates: fallback_units_per_usd: '1000' windows: - key: daily duration_minutes: 1440 included_units: '10000' rate_card_id: type: - string - 'null' description: >- Rate card reference. On policy writes, omission preserves the current reference and null detaches it; on plan replacement omission clears it. example: airc_example rate_card_source: type: - string - 'null' enum: - policy - plan description: >- Source of the effective rate card. Null when no card is configured. - policy: Selected directly on the customer policy. - plan: Inherited from the attached plan. example: policy plan: type: - object - 'null' properties: id: type: string description: Unique Hyperline identifier for this resource. example: aiplan_example name: type: string description: Human-readable resource name. example: Support agent plan required: - id - name description: Attached plan summary, or null. example: id: aiplan_example name: Support agent plan settlement_interval_minutes: type: - number - 'null' description: >- Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule. example: 60 settlement_schedule: type: - string - 'null' enum: - calendar_month description: >- Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes. - calendar_month: Settles at the end of each UTC calendar month. example: calendar_month resolved_rate_card: type: - object - 'null' properties: fallback_per_usd: type: - string - 'null' pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i description: >- Credits, allowance units, or major currency units per USD of provider cost. Null leaves unmatched usage unpriced. example: '1' layer_count: type: number description: >- Number of pricing sources contributing to the effective card. example: 1 llm_rows: type: number description: Number of LLM pricing rows. example: 1 item_rows: type: number description: Number of item rows. example: 0 has_default_llm_row: type: boolean description: >- Whether a wildcard LLM row supplies rates for otherwise unmatched models. example: true required: - fallback_per_usd - layer_count - llm_rows - item_rows - has_default_llm_row description: >- Summary of the effective pricing after applying rate-card inheritance. Null when no card resolves. example: fallback_per_usd: '1000' layer_count: 1 llm_rows: 1 item_rows: 0 has_default_llm_row: true blocked: type: boolean description: Whether spending is disabled for this billing scope. example: false created_at: type: string format: date-time description: Creation time as a UTC ISO 8601 timestamp. example: '2026-09-01T00:00:00Z' updated_at: type: string format: date-time description: Last update time as a UTC ISO 8601 timestamp. example: '2026-09-02T12:00:00Z' required: - id - customer_id - agent_slug - is_default - mode - wallet_id - credit_product_id - markup_percent - overage_mode - overage_markup_percent - overage_rate_card_id - overage_rate_card_source - overage_wallet_id - floor - credit_rates - window_rates - rate_card_id - rate_card_source - plan - settlement_interval_minutes - settlement_schedule - resolved_rate_card - blocked - created_at - updated_at '400': description: Invalid request. content: application/json: schema: type: object properties: message: type: string required: - message '404': description: Policy not found content: application/json: schema: type: object properties: message: type: string required: - message '409': description: The request conflicts with the current configuration. content: application/json: schema: type: object properties: message: type: string required: - message security: - bearer: [] components: securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.