This list API returns all subscriptions for a given plan number or subscription id or buyer email and provides additional parameters to include ratecard and commitment details. This API expects exactly one of the above mentioned parameters as input. If more than one parameters are provided the API will throw a 400 - invalid parameters exception and if no parameters are provided it will throw a 400 - missing parameter exception
Fetches all pages of results. If you provide this option, then you cannot provide the
Buyer Email Id
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
--generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
Boolean value to decide whether commitment services will be shown
The maximum number of items to return in a paginated “List” call. Default: (50)
The value of the opc-next-page response header from the previous “List” call.
When fetching results, the number of results to fetch per call. Only valid when used with
--limit, and ignored otherwise.
The Plan Number
The field to sort by. You can provide one sort order (sortOrder).
Accepted values are:
The sort order to use, either ascending (ASC) or descending (DESC).
Accepted values are:
Line level Subscription Id
This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.
The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
oci --help for help on global parameters.
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/osub-subscription/subscription/subscription/list.html#cmdoption-compartment-id oci osub-subscription subscription subscription list --compartment-id $compartment_id