### GET /v1/billing-reports-snapshot-config Source: https://cloud.ibm.com/apidocs/metering-reporting.json Returns the configuration of snapshot of the billing reports setup by the customer for the given Account Id. ```markdown ### Parameters - **account_id** (string, query, required): Account ID for which the billing report snapshot is configured. (example: "abc") ### Responses #### 200 - Snapshot configuration was returned successfully. **Snapshot_Config** - **account_id** (string): Account ID for which billing report snapshot is configured. (example: "abc") - **state** (string (enabled|disabled)): Status of the billing snapshot configuration. Possible values are [enabled, disabled]. (example: "enabled") ("enabled"|"disabled") - **account_type** (string (account|enterprise)): Type of account. Possible values are [enterprise, account]. (example: "account") ("account"|"enterprise") - **interval** (string (daily)): Frequency of taking the snapshot of the billing reports. (example: "daily") ("daily") - **versioning** (string (new|overwrite)): A new version of report is created or the existing report version is overwritten with every update. (example: "new") ("new"|"overwrite") - **report_types** (array (string (account_summary|enterprise_summary|account_resource_instance_usage))): The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. (example: ["account_summary","enterprise_summary","account_resource_instance_usage"]) - **compression** (string): Compression format of the snapshot report. (example: "GZIP") - **content_type** (string): Type of content stored in snapshot report. (example: "text/csv") - **cos_reports_folder** (string): The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports" (example: "IBMCloud-Billing-Reports") - **cos_bucket** (string): The name of the COS bucket to store the snapshot of the billing reports. (example: "bucket_name") - **cos_location** (string): Region of the COS instance. (example: "us-south") - **cos_endpoint** (string): The endpoint of the COS instance. (example: "https://s3.us-west.cloud-object-storage.test.appdomain.cloud") - **created_at** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was created. (example: 1687469854342) - **last_updated_at** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was last updated. (example: 1687469989326) - **history** (array (object)): List of previous versions of the snapshot configurations. Array items: - **start_time** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was created. (example: 1687469854342) - **end_time** (integer (int64)): Timestamp in milliseconds when the snapshot configuration ends. (example: 1687469989326) - **updated_by** (string): Account that updated the billing snapshot configuration. (example: "IBMid-506PR16K14") - **account_id** (string): Account ID for which billing report snapshot is configured. (example: "abc") - **state** (string (enabled|disabled)): Status of the billing snapshot configuration. Possible values are [enabled, disabled]. (example: "enabled") ("enabled"|"disabled") - **account_type** (string (account|enterprise)): Type of account. Possible values [enterprise, account]. (example: "account") ("account"|"enterprise") - **interval** (string (daily)): Frequency of taking the snapshot of the billing reports. (example: "daily") ("daily") - **versioning** (string (new|overwrite)): A new version of report is created or the existing report version is overwritten with every update. (example: "new") ("new"|"overwrite") - **report_types** (array (string (account_summary|enterprise_summary|account_resource_instance_usage))): The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. (example: ["account_summary","enterprise_summary","account_resource_instance_usage"]) - **compression** (string): Compression format of the snapshot report. (example: "GZIP") - **content_type** (string): Type of content stored in snapshot report. (example: "text/csv") - **cos_reports_folder** (string): The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports" (example: "IBMCloud-Billing-Reports") - **cos_bucket** (string): The name of the COS bucket to store the snapshot of the billing reports. (example: "bucket_name") - **cos_location** (string): Region of the COS instance. (example: "us-south") - **cos_endpoint** (string): The endpoint of the COS instance. (example: "https://s3.us-west.cloud-object-storage.test.appdomain.cloud") #### 400 - Bad request **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 401 - Unauthenticated **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 403 - Unauthorized **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 404 - Not found **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 500 - Internal Server Error **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 503 - Service Unavailable **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. ### Example Usage ```bash curl -X GET "https://billing.cloud.ibm.com/v1/billing-reports-snapshot-config?account_id=abc" ``` ``` -------------------------------- ### GET /v4/accounts/{account_id}/focus/{month} Source: https://cloud.ibm.com/apidocs/metering-reporting.json Query for resource instance usage in FOCUS (FinOps Open Cost and Usage Specification) format. This endpoint supports two response formats: - **JSON format** (format=json or default): Returns paginated JSON response from the metering-reporting API with the FOCUS_Usage schema. Supports pagination with _limit and _start parameters. Resource names and tags are always included in the FOCUS data structure. - **CSV format** (format=csv): Returns a CSV file download from the metering-report-downloader service with FOCUS-compliant columns. The CSV response does not support pagination parameters. Account billing administrator is authorized to access this report. ```markdown ### Parameters - **format** (string (json|csv), query, optional): The format of the response. Use `json` for paginated JSON response from the metering-reporting API, or `csv` to download a CSV file from the metering-report-downloader service. Defaults to `json`. - **x-focus-version** (string (1.2), header, optional): The FOCUS specification version to use for the response. Currently only version `1.2` is supported. Defaults to `1.2` if not specified. - **_limit** (integer (int32), query, optional): Number of usage records returned. The default value is 30. Maximum value is 200. - **_start** (string, query, optional): The offset from which the records must be fetched. Offset information is included in the response. ### Responses #### 200 - Resource instance usage returned successfully. Response format depends on the `format` parameter: - **format=json** (default): Returns paginated JSON with Instances_Usage schema - **format=csv**: Returns CSV file with FOCUS-compliant columns and appropriate headers **FOCUS_Usage** - **limit** (integer): Maximum number of reports in the response. - **count** (integer): Number of reports in the response. - **first** (object): Link to the first page of the search query. - **href** (string): Link to a page of query results. - **next** (object): Link to the next page of the search query. - **href** (string): Link to a page of query results. - **offset** (string): Value of the `_start` query parameter to fetch the next page. - **resources** (array (FOCUS_Resource)): List of FOCUS-compliant usage records. Array items: - **AvailabilityZone** (string): Availability zone where the resource is located. - **BilledCost** (number): Cost billed to the customer after applying all discounts and credits. - **BillingAccountId** (string): Unique identifier for the billing account. - **BillingAccountName** (string): Display name of the billing account. - **BillingAccountType** (string): Type of billing account (for example, Enterprise, Subscription, PAYG). - **BillingCurrency** (string): Currency code (ISO 4217) for billing. - **BillingPeriodEnd** (string (date-time)): End date and time of the billing period. - **BillingPeriodStart** (string (date-time)): Start date and time of the billing period. - **CapacityReservationId** (string): Identifier for capacity reservation. Not currently used by IBM Cloud. - **CapacityReservationStatus** (string): Status of capacity reservation. Not currently used by IBM Cloud. - **ChargeCategory** (string): Category of the charge (for example, Usage, Purchase, Tax, Adjustment). - **ChargeClass** (string): Class of the charge. Not currently used by IBM Cloud. - **ChargeDescription** (string): Human-readable description of the charge. - **ChargeFrequency** (string): Frequency of the charge (for example, Usage-Based, One-Time, Recurring). - **ChargePeriodEnd** (string (date-time)): End date and time of the charge period. - **ChargePeriodStart** (string (date-time)): Start date and time of the charge period. - **CommitmentDiscountCategory** (string): Category of commitment-based discount. - **CommitmentDiscountId** (string): Unique identifier for the commitment discount. - **CommitmentDiscountName** (string): Display name of the commitment discount. - **CommitmentDiscountQuantity** (number): Quantity of commitment discount applied. - **CommitmentDiscountStatus** (string): Status of the commitment discount. - **CommitmentDiscountType** (string): Type of commitment discount. - **CommitmentDiscountUnit** (string): Unit of measure for the commitment discount. - **ConsumedQuantity** (number): Quantity of the resource consumed. - **ConsumedUnit** (string): Unit of measure for consumed quantity. - **ContractedCost** (number): Cost based on contracted rates. - **ContractedUnitPrice** (number): Contracted price per unit. - **EffectiveCost** (number): Amortized cost after applying discounts and credits. - **InvoiceId** (string): Identifier for the invoice. Not currently used by IBM Cloud. - **InvoiceIssuerName** (string): Name of the invoice issuer (typically "IBM"). - **ListCost** (number): Cost at list price before any discounts. - **ListUnitPrice** (number): List price per unit before discounts. - **PricingCategory** (string): Pricing model category (for example, Standard, On-Demand). - **PricingCurrency** (string): Currency code (ISO 4217) for pricing. - **PricingCurrencyContractedUnitPrice** (number): Contracted unit price in pricing currency. Not currently used by IBM Cloud. - **PricingCurrencyEffectiveCost** (number): Effective cost in pricing currency. Not currently used by IBM Cloud. - **PricingCurrencyListUnitPrice** (number): List unit price in pricing currency. Not currently used by IBM Cloud. - **PricingQuantity** (string): Quantity used for pricing calculations. - **PricingUnit** (string): Unit of measure for pricing. - **ProviderName** (string): Name of the cloud provider (typically "IBM Cloud"). - **PublisherName** (string): Name of the service publisher. - **RegionId** (string): Identifier for the region. - **RegionName** (string): Display name of the region. - **ResourceId** (string): Unique identifier for the resource. - **ResourceName** (string): Display name of the resource. - **ResourceType** (string): Type or category of the resource. - **ServiceCategory** (string): High-level category of the service (for example, Compute, Storage, Network). - **ServiceName** (string): Name of the service. - **ServiceSubcategory** (string): Subcategory of the service. - **SkuId** (string): Stock Keeping Unit (SKU) identifier. - **SkuMeter** (string): Meter associated with the SKU. - **SkuPriceDetails** (string): Detailed pricing information for the SKU. Not currently used by IBM Cloud. - **SkuPriceId** (string): Identifier for the SKU price. Not currently used by IBM Cloud. - **SubAccountId** (string): Identifier for sub-account. Not currently used by IBM Cloud. - **SubAccountName** (string): Name of sub-account. Not currently used by IBM Cloud. - **SubAccountType** (string): Type of sub-account. Not currently used by IBM Cloud. - **Tags** (string): User-defined tags associated with the resource. - **x_DiscountId** (string): IBM-specific discount identifier. - **x_DiscountName** (string): IBM-specific discount name. - **x_DiscountQuantity** (number): IBM-specific discount quantity applied. - **x_DiscountType** (string): IBM-specific discount type. - **x_OfferId** (string): IBM-specific offer identifier. - **x_OfferCredit** (number): IBM-specific offer credit amount. #### 400 - Bad request. Invalid parameters such as invalid date format, future date, invalid format parameter value, or unsupported FOCUS version. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 401 - Unauthorized. Invalid or missing IAM token. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 403 - Forbidden. User does not have permission to access this account's billing data. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 404 - Not found. Account not found or no data available for the specified month. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 429 - Too many requests. Rate limit exceeded. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 500 - Internal server error. An unexpected error occurred while processing the request. **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. ### Example Usage ```bash curl -X GET "https://billing.cloud.ibm.com/v4/accounts/{account_id}/focus/{month}?format=json&_limit=30&_start=string" ``` ``` -------------------------------- ### POST /v1/billing-reports-snapshot-config Source: https://cloud.ibm.com/apidocs/metering-reporting.json Snapshots of the billing reports would be taken on a periodic interval and stored based on the configuration setup by the customer for the given Account Id. ```markdown ### Request Body **Content-Type:** application/json - **account_id** (string) (required): Account ID for which billing report snapshot is configured. (example: "abc") - **interval** (string (daily)) (required): Frequency of taking the snapshot of the billing reports. (example: "daily") ("daily") - **cos_bucket** (string) (required): The name of the COS bucket to store the snapshot of the billing reports. (example: "bucket_name") - **cos_location** (string) (required): Region of the COS instance. (example: "us-south") - **cos_reports_folder** (string): The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports" (example: "IBMCloud-Billing-Reports") - **report_types** (array (string (account_summary|enterprise_summary|account_resource_instance_usage))): The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. (example: ["account_summary","enterprise_summary","account_resource_instance_usage"]) - **versioning** (string (new|overwrite)): A new version of report is created or the existing report version is overwritten with every update. Defaults to "new" (example: "new") ("new"|"overwrite") ### Responses #### 201 - Indicates that the billing reports snapshot for the respective account is successfully created with the submitted payload. **Snapshot_Config** - **account_id** (string): Account ID for which billing report snapshot is configured. (example: "abc") - **state** (string (enabled|disabled)): Status of the billing snapshot configuration. Possible values are [enabled, disabled]. (example: "enabled") ("enabled"|"disabled") - **account_type** (string (account|enterprise)): Type of account. Possible values are [enterprise, account]. (example: "account") ("account"|"enterprise") - **interval** (string (daily)): Frequency of taking the snapshot of the billing reports. (example: "daily") ("daily") - **versioning** (string (new|overwrite)): A new version of report is created or the existing report version is overwritten with every update. (example: "new") ("new"|"overwrite") - **report_types** (array (string (account_summary|enterprise_summary|account_resource_instance_usage))): The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. (example: ["account_summary","enterprise_summary","account_resource_instance_usage"]) - **compression** (string): Compression format of the snapshot report. (example: "GZIP") - **content_type** (string): Type of content stored in snapshot report. (example: "text/csv") - **cos_reports_folder** (string): The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports" (example: "IBMCloud-Billing-Reports") - **cos_bucket** (string): The name of the COS bucket to store the snapshot of the billing reports. (example: "bucket_name") - **cos_location** (string): Region of the COS instance. (example: "us-south") - **cos_endpoint** (string): The endpoint of the COS instance. (example: "https://s3.us-west.cloud-object-storage.test.appdomain.cloud") - **created_at** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was created. (example: 1687469854342) - **last_updated_at** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was last updated. (example: 1687469989326) - **history** (array (object)): List of previous versions of the snapshot configurations. Array items: - **start_time** (integer (int64)): Timestamp in milliseconds when the snapshot configuration was created. (example: 1687469854342) - **end_time** (integer (int64)): Timestamp in milliseconds when the snapshot configuration ends. (example: 1687469989326) - **updated_by** (string): Account that updated the billing snapshot configuration. (example: "IBMid-506PR16K14") - **account_id** (string): Account ID for which billing report snapshot is configured. (example: "abc") - **state** (string (enabled|disabled)): Status of the billing snapshot configuration. Possible values are [enabled, disabled]. (example: "enabled") ("enabled"|"disabled") - **account_type** (string (account|enterprise)): Type of account. Possible values [enterprise, account]. (example: "account") ("account"|"enterprise") - **interval** (string (daily)): Frequency of taking the snapshot of the billing reports. (example: "daily") ("daily") - **versioning** (string (new|overwrite)): A new version of report is created or the existing report version is overwritten with every update. (example: "new") ("new"|"overwrite") - **report_types** (array (string (account_summary|enterprise_summary|account_resource_instance_usage))): The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. (example: ["account_summary","enterprise_summary","account_resource_instance_usage"]) - **compression** (string): Compression format of the snapshot report. (example: "GZIP") - **content_type** (string): Type of content stored in snapshot report. (example: "text/csv") - **cos_reports_folder** (string): The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports" (example: "IBMCloud-Billing-Reports") - **cos_bucket** (string): The name of the COS bucket to store the snapshot of the billing reports. (example: "bucket_name") - **cos_location** (string): Region of the COS instance. (example: "us-south") - **cos_endpoint** (string): The endpoint of the COS instance. (example: "https://s3.us-west.cloud-object-storage.test.appdomain.cloud") #### 400 - Bad request **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 401 - Unauthenticated **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 403 - Unauthorized **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 404 - Not found **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 409 - Conflict **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 424 - Dependency failure **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 500 - Internal Server Error **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 503 - Service Unavailable **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. ### Example Usage ```bash curl -X POST "https://billing.cloud.ibm.com/v1/billing-reports-snapshot-config" \ -H "Content-Type: application/json" \ -d '{ "account_id": "abc", "interval": "daily", "cos_bucket": "bucket_name", "cos_location": "us-south", "cos_reports_folder": "IBMCloud-Billing-Reports", "report_types": [ "account_summary", "enterprise_summary", "account_resource_instance_usage" ], "versioning": "new" }' ``` ``` -------------------------------- ### GET /v4/accounts/{account_id}/summary/{billingmonth} Source: https://cloud.ibm.com/apidocs/metering-reporting.json Returns the summary for the account for a given month. Account billing managers are authorized to access this report. ```markdown ### Responses #### 200 - Account summary was returned successfully **Account_Summary** - **account_id** (string) (required): The ID of the account. - **account_resources** (array (Resource)): The list of account resources for the month. Array items: - **resource_id** (string) (required): The ID of the resource. - **catalog_id** (string): The catalog ID of the resource - **resource_name** (string): The name of the resource. - **billable_cost** (number) (required): The billable charges for the account. - **billable_rated_cost** (number) (required): The pre-discounted billable charges for the account. - **non_billable_cost** (number) (required): The non-billable charges for the account. - **non_billable_rated_cost** (number) (required): The pre-discounted non-billable charges for the account. - **plans** (array (Plan)) (required): All the plans in the resource. Array items: - **plan_id** (string) (required): The ID of the plan. - **plan_name** (string): The name of the plan. - **pricing_region** (string): The pricing region for the plan. - **pricing_plan_id** (string): The ID of the pricing plan used to rate the usage. - **billable** (boolean) (required): Indicates if the plan charges are billed to the customer. - **cost** (number) (required): The total cost incurred by the plan. - **rated_cost** (number) (required): Total pre-discounted cost incurred by the plan. - **subscription_id** (string): The ID of the service subscription with effective timestamp - **usage** (array (Metric)) (required): All the metrics in the plan. Array items: - **metric** (string) (required): The ID of the metric. (example: "UP-TIME") - **metric_name** (string): The name of the metric. (example: "UP-TIME") - **quantity** (number) (required): The aggregated value for the metric. (example: 711.11) - **rateable_quantity** (number): The quantity that is used for calculating charges. (example: 700) - **cost** (number) (required): The cost incurred by the metric. (example: 123.45) - **rated_cost** (number) (required): Pre-discounted cost incurred by the metric. (example: 130) - **price** (array (unknown)): The price with which the cost was calculated. - **unit** (string): The unit that qualifies the quantity. (example: "HOURS") - **unit_name** (string): The name of the unit. (example: "HOURS") - **non_chargeable** (boolean): When set to `true`, the cost is for informational purpose and is not included while calculating the plan charges. (example: true) - **discounts** (array (Discount)) (required): All the discounts applicable to the metric. Array items: - **ref** (string) (required): The reference ID of the discount. (example: "Discount-d27beddb-111b-4bbf-8cb1-b770f531c1a9") - **name** (string): The name of the discount indicating category. (example: "platform-discount") - **display_name** (string): The name of the discount. (example: "Platform Service Discount") - **discount** (number) (required): The discount percentage. (example: 5) - **volume_discount** (number): This percentage reflects the reduction to the original cost that you receive under a volume based pricing structure - **volume_cost** (number): The original cost adjusted for volume based discounts that are applied at the account level - **discounts** (array (Discount)) (required): All the discounts applicable to the plan. Array items: - **pending** (boolean): Pending charge from classic infrastructure. (example: true) - **discounts** (array (Discount)) (required): All the discounts applicable to the resource. Array items: - **month** (string) (required): The month in which usages were incurred. Represented in yyyy-mm format. - **billing_country_code** (string) (required): Country - **billing_currency_code** (string) (required): The currency in which the account is billed. - **resources** (object) (required): Charges related to cloud resources. - **billable_cost** (number) (required): The billable charges for all cloud resources used in the account. - **non_billable_cost** (number) (required): Non-billable charges for all cloud resources used in the account. - **offers** (array (Offer)) (required): The list of offers applicable for the account for the month. Array items: - **offer_id** (string) (required): The ID of the offer. - **credits_total** (number) (required): The total credits before applying the offer. - **offer_template** (string) (required): The template with which the offer was generated. - **valid_from** (string (date-time)) (required): The date from which the offer is valid. - **created_by_email_id** (string) (required): The offer's creator's email id - **expires_on** (string (date-time)) (required): The date until the offer is valid. - **credits** (object) (required): Credit information related to an offer. - **starting_balance** (number) (required): The available credits in the offer at the beginning of the month. - **used** (number) (required): The credits used in this month. - **balance** (number) (required): The remaining credits in the offer. - **support** (array (object)) (required): Support-related charges. Array items: - **cost** (number) (required): The monthly support cost. - **type** (string) (required): The type of support. - **overage** (number) (required): Additional support cost for the month. - **support_resources** (array (unknown)): The list of support resources for the month. - **subscription** (object) (required): A summary of charges and credits related to a subscription. - **overage** (number): The charges after exhausting subscription credits and offers credits. - **subscriptions** (array (object)): The list of subscriptions applicable for the month. Array items: - **subscription_id** (string) (required): The ID of the subscription. - **charge_agreement_number** (string) (required): The charge agreement number of the subsciption. - **type** (string) (required): Type of the subscription - **subscription_amount** (number) (required): The credits available in the subscription for the month. - **start** (string (date-time)) (required): The date from which the subscription was active. - **end** (string (date-time)): The date until which the subscription is active. End time is unavailable for PayGO accounts. - **credits_total** (number) (required): The total credits available in the subscription. - **terms** (array (object)) (required): The terms through which the subscription is split into. Array items: - **start** (string (date-time)) (required): The start date of the term. - **end** (string (date-time)) (required): The end date of the term. - **credits** (object) (required): Information about credits related to a subscription. - **total** (number) (required): The total credits available for the term. - **starting_balance** (number) (required): The unused credits in the term at the beginning of the month. - **used** (number) (required): The credits used in this month. - **balance** (number) (required): The remaining credits in this term. #### 400 - Invalid parameters **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 401 - Unauthenticated **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 403 - Unauthorized **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 404 - Account Not Found **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. #### 500 - Unexpected errors **Error_Model** - **errors** (array (object)) (required): Errors while serving the request. Array items: - **code** (string) (required): Error code identifying a problem. - **message** (string): Message describing the error. - **more_info** (object): More information about the error. ### Example Usage ```bash curl -X GET "https://billing.cloud.ibm.com/v4/accounts/{account_id}/summary/{billingmonth}" ``` ```