> ## Documentation Index > Fetch the complete documentation index at: https://developers.readyforcommerce.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the billing summary > Reads the organization's subscription, each module's projected bill and cap, the card's summary and any open invoice. ## OpenAPI ````yaml /openapi/en.json get /api/v1/orgs/{orgId}/core/billing openapi: 3.1.0 info: title: Ready for Commerce API version: 1.0.0 description: >- The reference of every operation of the Ready for Commerce API. Every operation is in beta until launch. servers: - url: https://app.readyforcommerce.com security: - apiKey: [] tags: - name: Credentials description: >- The credential that calls: its organization, its permissions, its limits and the calls it may still make. - name: Organization description: 'The organization''s settings: its name, slug and currency.' - name: Billing description: >- The organization's subscription and each module's bill and cap, and this month's usage against its free allowance. - name: Record types description: >- The kinds of record the credential may import or export, with each one's fields and options. - name: Imports description: >- Bring CSV or Excel files in: upload or fetch a file, inspect and check it, then start the import and read its results. - name: Files description: An uploaded file's status, until it is ready or rejected. - name: Exports description: Export the records a filter matches to CSV or Excel files, kept 14 days. - name: Export templates description: Saved export setups, by name, to run the same export again. - name: Jobs description: >- Long work runs as a job: follow its state and progress, read its messages, download its files or cancel it. - name: Search description: >- Find the organization's records by words, a typo included, grouped by kind. - name: Version history description: >- A record's versions, newest first: compare one with another and restore the record to it. - name: Incidents description: >- The organization's problems you may see: mark them read or unread, and resolve them. - name: Notifications description: >- Your notifications, newest first: mark one read or unread, or all of them read. - name: Saved views description: >- A table's search, filters, order and columns saved under a name, yours or shared with the organization, and the view each table opens with for you. - name: Store connections description: >- The organization's stores, connected with their pasted keys: list them, connect one, reconnect it with new keys or disconnect it. - name: Products description: >- The organization's products with their options, variants and prices: list them, read one, create one, change one's content, its prices or its status, duplicate one as a draft, or delete one. paths: /api/v1/orgs/{orgId}/core/billing: get: tags: - Billing summary: Get the billing summary description: >- Reads the organization's subscription, each module's projected bill and cap, the card's summary and any open invoice. operationId: coreGetBilling parameters: - schema: type: string format: uuid in: path name: orgId required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingSummary' default: description: >- An error, as `application/problem+json`: its `code` says what went wrong and `params` holds its values content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: code: enum: - core.bad_request - core.invalid_credential - core.forbidden - core.module_not_enabled - core.module_read_only - core.not_found - core.conflict - core.org_deletion_scheduled - core.payload_too_large - core.unsupported_media_type - core.validation_failed - core.rate_limited - core.surface_disabled - core.internal - core.unavailable components: schemas: BillingSummary: type: object properties: currency: type: string enum: - AED - AFN - ALL - AMD - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAD - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMW - ZWG status: type: string enum: - none - active - past_due - canceled - complimentary currentPeriodEnd: anyOf: - type: string format: date-time - type: 'null' cancelAt: anyOf: - type: string format: date-time - type: 'null' complimentaryUntil: anyOf: - type: string format: date-time - type: 'null' projectedTotalMinor: type: integer minimum: 0 modules: type: array items: type: object properties: module: type: string enum: - catalog - pricing projectedMinor: type: integer minimum: 0 capMinor: anyOf: - type: integer minimum: 0 - type: 'null' units: type: array items: type: object properties: unit: type: string count: type: integer minimum: 0 freeAllowance: type: integer minimum: 0 left: type: integer minimum: 0 capAt: anyOf: - type: integer minimum: 0 - type: 'null' tiers: type: array items: type: object properties: upTo: anyOf: - type: integer minimum: 0 - type: 'null' unitAmountMinor: type: integer minimum: 0 required: - upTo - unitAmountMinor additionalProperties: false required: - unit - count - freeAllowance - left - capAt - tiers additionalProperties: false required: - module - projectedMinor - capMinor - units additionalProperties: false estimate: type: object properties: projectedTotalMinor: type: integer minimum: 0 modules: type: object propertyNames: type: string enum: - catalog - pricing additionalProperties: type: object properties: projectedMinor: type: integer minimum: 0 capMinor: anyOf: - type: integer minimum: 0 - type: 'null' required: - projectedMinor - capMinor additionalProperties: false required: - projectedTotalMinor - modules additionalProperties: false rateMissing: type: boolean const: true card: type: object properties: brand: type: string last4: type: string expMonth: type: integer expYear: type: integer required: - brand - last4 - expMonth - expYear additionalProperties: false openInvoice: type: object properties: amountMinor: type: integer minimum: 0 issuedOn: type: string format: date declineCode: type: string nextAttemptAt: type: string format: date-time actionRequired: type: boolean hostedUrl: type: string format: uri required: - amountMinor - issuedOn - actionRequired additionalProperties: false cardUnavailable: type: boolean required: - currency - status - currentPeriodEnd - cancelAt - complimentaryUntil - projectedTotalMinor - modules - cardUnavailable additionalProperties: false Problem: type: object properties: type: type: string pattern: ^urn:rfc:problem:[\s\S]{0,}\.[\s\S]{0,}$ status: type: integer title: type: string code: type: string pattern: ^[\s\S]{0,}\.[\s\S]{0,}$ params: type: object propertyNames: type: string additionalProperties: {} requestId: type: string errors: type: array items: type: object properties: location: type: string pointer: type: string code: type: string params: type: object propertyNames: type: string additionalProperties: {} required: - location - pointer - code additionalProperties: false required: - type - status - code - requestId additionalProperties: false securitySchemes: apiKey: type: http scheme: bearer description: >- An organization's API key, sent on every call as `Authorization: Bearer `. A person of the organization creates it in the app, in **Settings › API and connections › API keys**. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.