oracle.oci.oci_onesubscription_billing_schedule_facts – Fetches details about one or multiple BillingSchedule resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_onesubscription_billing_schedule_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple BillingSchedule resources in Oracle Cloud Infrastructure

  • This list API returns all billing schedules for given subscription id and for a particular Subscribed Service if provided

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string / required
The OCID of the root compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • ORDERNUMBER
  • TIMEINVOICING
The field to sort by. You can provide one sort order ('sortOrder').
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending ('ASC') or descending ('DESC').
subscribed_service_id
string
This param is used to get only the billing schedules for a particular Subscribed Service
subscription_id
string / required
This param is used to get only the billing schedules for a particular Subscription Id
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: List billing_schedules
  oci_onesubscription_billing_schedule_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    subscribed_service_id: "ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx"
    sort_order: ASC
    sort_by: ORDERNUMBER

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
billing_schedules
complex
on success
List of BillingSchedule resources

Sample:
[{'amount': 'amount_example', 'ar_customer_transaction_id': 'ocid1.arcustomertransaction.oc1..xxxxxxEXAMPLExxxxxx', 'ar_invoice_number': 'ar_invoice_number_example', 'billing_frequency': 'billing_frequency_example', 'invoice_status': 'INVOICED', 'net_unit_price': 'net_unit_price_example', 'order_number': 'order_number_example', 'product': {'name': 'name_example', 'part_number': 'part_number_example'}, 'quantity': 'quantity_example', 'subscribed_service_id': 'ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx', 'time_end': '2013-10-20T19:20:30+01:00', 'time_invoicing': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00'}]
 
amount
string
on success
Billing schedule line net amount

Sample:
amount_example
 
ar_customer_transaction_id
string
on success
Indicates the associated AR Customer transaction id a unique identifier existing on AR.

Sample:
ocid1.arcustomertransaction.oc1..xxxxxxEXAMPLExxxxxx
 
ar_invoice_number
string
on success
Indicates the associated AR Invoice Number

Sample:
ar_invoice_number_example
 
billing_frequency
string
on success
Billing frequency

Sample:
billing_frequency_example
 
invoice_status
string
on success
Billing schedule invoice status

Sample:
INVOICED
 
net_unit_price
string
on success
Billing schedule net unit price

Sample:
net_unit_price_example
 
order_number
string
on success
Order number associated with the Subscribed Service

Sample:
order_number_example
 
product
complex
on success

   
name
string
on success
Product name

Sample:
name_example
   
part_number
string
on success
Indicates the associated AR Invoice Number

Sample:
part_number_example
 
quantity
string
on success
Billing schedule quantity

Sample:
quantity_example
 
subscribed_service_id
string
on success
SPM internal Subscribed Service ID

Sample:
ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx
 
time_end
string
on success
Billing schedule end date

Sample:
2013-10-20T19:20:30+01:00
 
time_invoicing
string
on success
Billing schedule invoicing date

Sample:
2013-10-20T19:20:30+01:00
 
time_start
string
on success
Billing schedule start date

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)