``avn billing-group`` ===================== This article has the full list of commands for managing billing groups assigned to organizations using ``avn billing-group``. An account is the same as an :doc:`organization `. ``avn billing-group assign-projects`` ''''''''''''''''''''''''''''''''''''' Adds projects to a billing group. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The ID of your billing group * - ``projects`` - Names of the projects to assign, separated by spaces **Example:** Add the project ``new-project`` to the existing billing group with id ``55b0e547-58f9-48de-8808-807d385d1f95`` .. code:: shell avn biling-group assign-projects 55b0e547-58f9-48de-8808-807d385d1f95 new-project ``avn billing-group create`` and ``avn billing-group update`` ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Creates a new billing group with ``create`` or amends a billing group with ``update``. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``name`` (required for ``create``) - Note: This is a positional argument, not a switch * - ``ID`` (required for ``update``) - Note: This is a positional argument, not a switch * - ``--account-id`` - The ID of the organization or unit to create the billing group in * - ``--card-id`` - The card ID (see ``avn card``) * - ``--vat-id`` - VAT ID for this billing group * - ``--billing-currency`` - The currency to bill in: ``AUD``, ``CAD``, ``CHF``, ``DKK``, ``EUR``, ``GBP``, ``JPY``, ``NOK``, ``NZD``, ``SEK``, ``SGD``, or ``USD`` * - ``--billing-extra-text`` - Information to include in an invoice (for example, a cost center number) * - ``--billing-email`` - Email for the billing contact * - ``--company`` - Company name * - ``--address-line`` - First line of address * - ``--country-code`` - `Code `_ for the billing country * - ``--city`` - City * - ``--state`` - State / Province * - ``--zip-code`` - ZIP / Post Code **Example:** Create a billing group named ``qa-dept`` in the organization that has the account ID ``c59dde4j9`` and give it the following properties: * currency: ``EUR`` * e-mail address: ``billing@testers.dev`` * company name: ``testers`` * address: ``1 No Way`` * country code: ``SE`` * city: ``Stockholm`` .. code:: shell avn billing-group create qa-dept \ --account-id c59dde4j9 \ --billing-currency EUR \ --billing-email billing@testers.dev \ --company testers \ --address-line "1 No Way" \ --country-code SE \ --city Stockholm **Example:** Rename your ``qa-dept`` billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95`` to ``qa-department``. .. code:: shell avn billing-group update \ 55b0e547-58f9-48de-8808-807d385d1f95 \ --name qa-department ``avn billing-group credits-claim`` '''''''''''''''''''''''''''''''''''' Claims a credit code within your biling-group. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The billing group ID * - ``code`` - Credit Code **Example:** Claim the credit code ``sneaky-crab`` in the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group credits-claim 55b0e547-58f9-48de-8808-807d385d1f95 sneaky-crab ``avn billing-group credits-list`` '''''''''''''''''''''''''''''''''''' Lists all the credits redeemed in your billing-group .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The ID of your billing group **Example:** List credits claimed in the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95`` .. code:: shell avn billing-group credits-list 55b0e547-58f9-48de-8808-807d385d1f95 An example of ``avn billing-group credits-list`` output: .. code:: text CODE REMAINING_VALUE ======== =============== S18A11Y 0.00 ``avn billing-group delete`` '''''''''''''''''''''''''''''''''''' Deletes a billing group. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The billing group ID **Example:** Delete the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group delete 55b0e547-58f9-48de-8808-807d385d1f95 ``avn billing-group events`` ''''''''''''''''''''''''''''' Lists the activity for a given billing group. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The billing group ID **Example:** List activity for the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group events 55b0e547-58f9-48de-8808-807d385d1f95 An example of ``avn billing-group events`` output: .. code:: text CREATE_TIME ACTOR EVENT_DESC ==================== ================ =================================================================================================================== 2021-10-14T21:09:02Z Aiven Automation Set VAT ID state to invalid 2021-10-14T14:31:15Z me@you.com "Set billing email address to \"[\"\"me@you.io\"\"]\"" 2021-10-14T14:30:46Z me@you.com Set VAT ID state to unconfirmed 2021-10-14T13:08:45Z Aiven Automation Set VAT ID state to invalid 2021-10-14T08:15:09Z me@you.com "Added US$\"400\" credits to the billing group" 2021-10-14T08:15:00Z me@you.com Added project inzone-a-project to billing group 2021-10-14T08:15:00Z me@you.com Added project inzone-b-project to billing group 2021-10-14T08:15:00Z me@you.com Added project inzone-c-project to billing group 2021-10-14T08:15:00Z me@you.com Added project kona-a-project to billing group 2021-10-14T08:15:00Z me@you.com Added project kona-b-project to billing group 2021-10-14T08:15:00Z me@you.com Added project kona-c-project to billing group 2021-10-14T08:15:00Z me@you.com "Added user u2865a92fe3d (\"me@you.com\") to billing group \"u856238c-8213-6592-975e-cfc3662c1084\" with type" 2021-10-14T08:15:00Z me@you.com "Created billing group \"test-group\"" ``avn billing-group get`` '''''''''''''''''''''''''' Gets the details for a given billing group. .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The billing group ID **Example:** Get details for the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group get 55b0e547-58f9-48de-8808-807d385d1f95 An example of ``avn billing-group get`` output: .. code:: text BILLING_GROUP_ID BILLING_GROUP_NAME ACCOUNT_NAME ==================================== ================== ============ u856238c-8213-6592-975e-cfc3662c1084 test-group null ``avn billing-group invoice-lines`` '''''''''''''''''''''''''''''''''''' Retrieve the lines for a given invoice .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The ID of your billing group * - ``invoice``` - The number of the invoice **Example:** Retrieve lines from the invoice ``94885-2`` for the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group invoice-lines 55b0e547-58f9-48de-8808-807d385d1f95 94885-2 ``avn billing-group invoice-list`` '''''''''''''''''''''''''''''''''''' Lists all invoices for a billing group: .. list-table:: :header-rows: 1 :align: left * - Parameter - Information * - ``id`` - The ID of your billing group **Example:** List all invoices for the billing group with ID ``55b0e547-58f9-48de-8808-807d385d1f95``: .. code:: shell avn billing-group invoice-list 55b0e547-58f9-48de-8808-807d385d1f95 An example of ``avn billing-group invoice-list`` output: .. code:: text INVOICE_NUMBER PERIOD_BEGIN PERIOD_END STATE TOTAL_INC_VAT TOTAL_VAT_ZERO ============== ==================== ==================== ======== ============= ============== xxxxx-88 2022-09-01T00:00:00Z 2022-09-30T23:59:59Z estimate 0.00 0.00 ``avn billing-group list`` ''''''''''''''''''''''''''' Lists all of your billing-groups. **Example:** List all billing-groups: .. code:: shell avn billing-group list An example of ``avn billing-group list`` output: .. code:: text BILLING_GROUP_ID BILLING_GROUP_NAME ACCOUNT_NAME ==================================== =============================================== ====================== 2a4981e1-f988-4cb8-b1a8-xxxxxxxxxxxx Default billing group for abcdddddd Account 123 3c575695-4384-4b34-b58c-yyyyyyyyyyyy Default billing group for project test-demo Account 223 51ad078a-4eef-468d-964b-zzzzzzzzzzzz Default billing group for xxxxxxxxxxx Account 123